Using $ref
When you document an API, it is common to have some features which you use across several of API resources. In that case, you can create a snippet for such elements in order to use them multiple times when you need it. With OpenAPI 3.0, you can reference a definition hosted on any location. It can be the same server, or another one – for example, GitHub, SwaggerHub, and so on. To reference a defin
開発効率を上げる！Swaggerで作るWEB APIモック - ZOZO TECH BLOG
こんにちは。バックエンドエンジニアのじょーです。 みなさんは、開発初期の段階でWeb API（以下API）の実装が追いつかずクライアント側が開発できないという経験をしたことはありますか？ クライアント側はAPIがないと開発が滞ってしまうことがありますが、かといってAPIの開発も始まったばかりではすぐに必要なAPIを提供することができません。その問題を解決し、両者でスムーズに開発をすすめるために有効な方法の1つに、APIモックの作成があります。 弊社では、開発初期の段階でWeb APIのモックを作成し、スムーズに開発できるようにしています。 以前は、Apiaryをモック作成ツールとして利用していましたが、記法やエディターに使いづらい点があり最近Swaggerに移行しました。 本記事では、Swaggerを使ったAPIモックの作成方法と手順、また気をつけるべき点などを紹介します。 目次 Swag
Swagger+JSON SchemaでAPIの型をテストして開発サイクルをスピードアップさせた話 - pixiv inside
CTO兼福岡オフィス立ち上げ担当として新アプリを作っている@edvakfです。 JSON APIを開発しているとこういう問題がありがちですよね。 仕様どおりにAPIの形式を作ったはずだけどなんか自信が持てない テストでいくつかのキーが存在するかの簡単なチェックはしてるつもりだけど、全部チェックするのは大変すぎる APIのControllerやViewをリファクタリングしたらレスポンスの形が変わってアプリがめっちゃクラッシュし始めた というのが怖くて誰もリファクタリングできなくなった APIドキュメントがメンテされない 知らない間にレスポンスのフィールドが増えてたけどドキュメントに書いてない これらを解決したい！と思って試行錯誤したら、スマートに解決することができました。この記事ではRailsのことについて書きますが、考え方は他の言語・フレームワークでも同じです。 なお、今回使ったgemのバ
Do the Right Thing and Document Your Rails API with Swagger — SitePoint
January 9, 2017Do the Right Thing and Document Your Rails API with Swagger You probably spend most of your programming time trying to make your code better or faster or more efficient, don’t you? How much time to you spend actually documenting your code, though? Not a lot, if you’re like most of us, but documentation isn’t that important, right? Maybe, if you are working on a small project and you
SwaggerからOpenAPI Specificationへ。コンバーターを試す | NTT Communications Developer Portal
ついにOpenAPI Specificationがリリースされました。以前紹介した通り、文書構造が分かりやすくなったのが一番の特徴です。できることとしてはそれほど大きくは変わりません。 そこでこれまでSwagger.jsonで作ってきた内容をOpenAPI Specificationのフォーマットに整えるニーズが出てきます。手作業でやるのはとても大変なので、まずはコンバーターを使ってみましょう。それがMermade Swagger 2.0 to OpenAPI 3.0.0 converterです。オープンソース・ソフトウェアとして作られています。 使い方 使い方としてはテキストエリアにSwagger.json（YAMLでも可）を貼り付けるか、Swagger.jsonをアップロードとして指定します。なお、バリデーションだけ行うこともできます。 内容を変換するとYAML形式で表示されます。 一
第十二回 #渋谷java でSpring Boot で Swagger を使う話をしました - bati11 の 日記
渋谷java行ってきました。Spring Boot と Swagger というタイトルでLTさせていただきました。内容はSwaggerをSpringから便利に使えるSpringFoxのお話です。 http://swagger.io/ http://springfox.github.io/springfox/ speakerdeck.com WebAPIのドキュメント作成のコストはできるだけ下げたいところです。apiaryというサービスもすごく良さそうなのですが、Swaggerを使うことにしました。今のところ大きな不満はないです、自分でドキュメント書くよりは全然良いですね。 ビズリーチさんの会場は波の音が絶えず聞こえてて、すごく居心地がよかったです。ありがとうございました！
Swagger入門 - ぺーぺーSEのブログ
Swaggerとは SwaggerとはREST APIを記述する標準仕様。 MS、Google、IBMなどがRESTful APIの記述標準化を目指す「Open API Initiative」を立ち上げ、Swaggerベースで活動している。 SwaggerはSwagger / OpenAPI Spec 2.0に準拠したJSON・YAMLで記述する。 以降このJSON・YAMLで記載するSwaggerの定義ファイルをSwagger-Specと呼ぶ。 Swaggerの主要なツールに以下がある。 Swagger Editor Swagger-Spec記述用のエディタ Node.jsで起動し、ブラウザから使用する Mockサーバのソースコードを出力する機能（後述のSwagger Codegen使用）も持ち、APIテストも実施できる Webでも公開されている http://editor.swagge
swagger introduction - Qiita
tl;dr swaggerを使うとWebAPIの仕様書を決められたフォーマットに沿って作成できる API更新に追従して仕様書の自動更新ができる 将来的にはWebAPI仕様書の標準フォーマットになるかも？ メモ swagger coreとcodegenの役割が少し曖昧になっているから、明確化したい。 swaggerとは swaggerはREST APIのドキュメント記載に関するフォーマット仕様 RESTful API標準化団体(Open API Initiative）が採用。OpenAPI Specificationとして定義されている。 実態はJSON(YAML)形式のAPI仕様書とそれを取り巻くツール群 swaggerプロジェクト自体はフォーマット仕様以外にもドキュメントを書きやすくするツール、ドキュメント自動生成、ウェブベースのドキュメントビューワ等を提供している。 swaggerでの
Swaggerを使ってインタラクティブなWeb APIドキュメントをつくる - Qiita
この記事は、微妙に以下の記事の延長線上です。わかりにくければ、こちらから読んでいただいた方がいいかもしれません。 LittleBitsを使ったIoTをつくり、家の室温変化のグラフをインターネットから見る（前編） - Qiita 「インタラクティブなWeb APIドキュメント」とはどういうものか Swaggerというツールを使います。Web APIをYAMLで書いておいて、Swaggerでサーバを立てると、読むだけのドキュメントではなくて、以下のようにパラメータを指定して実際にHTTPリクエストを送ることができるWebページが生成されます。 以下が返ってきたレスポンスです。 以下は実物です。ご自由に動かしてみて下さい。 インタラクティブなWeb APIドキュメント まだちょっと分かりにくいという方のために、アノテーションからドキュメントを作れるswaggerの使い方 - gong023の日記
API Documentation & Design Tools for Teams | Swagger
Swagger places API specifications such as OpenAPI, AsyncAPI, and JSON Schema at the core of its architecture, which are crucial for guiding teams through the entire lifecycle of API design and documentation. This strategic focus ensures that our suite, including open source tools and SwaggerHub, delivers unparalleled efficiency and a seamless user experience. Explore the API Specifications Discove
Swaggerで始めるモデルファーストなAPI開発
This document summarizes a microservices meetup hosted by @mosa_siru. Key points include: 1. @mosa_siru is an engineer at DeNA and CTO of Gunosy. 2. The meetup covered Gunosy's architecture with over 45 GitHub repositories, 30 stacks, 10 Go APIs, and 10 Python batch processes using AWS services like Kinesis, Lambda, SQS and API Gateway. 3. Challenges discussed were managing 30 microservices, ensur
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Setting Up Swagger 2 with a Spring REST API | Baeldung
Spring Boot と Swagger #渋谷java