refirio.org

概要

RESTful API を構築するためのフレームワーク OpenAPI Specification | Swagger https://swagger.io/specification/ Swagger Editor https://editor.swagger.io/ Swagger UI https://petstore.swagger.io/ ■参考ページ Swagger が OpenAPI にリネームされて Open API Initiative が誕生してた https://r2.ag/swagger-to-openapi/ Swaggerの概要をまとめてみた。 - Qiita https://qiita.com/gcyata/items/342073fa7607fd4082bd SwaggerでRESTful APIの管理を楽にする - Qiita https://qiita.com/disc99/items/37228f5d687ad2969aa2 Swaggerとは何か？ - プログラマでありたい https://blog.takuros.net/entry/2015/12/02/082248 OpenAPI-Specification/3.0.0.md at master - OAI/OpenAPI-Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md Wordな職場にSwaggerを定着させようとして失敗したけど結局定着した話 - Qiita https://qiita.com/segur/items/26c16d4a5175dbbc7b91 ■RESTful成熟度レベル Swaggerを使うなら、RESTful成熟度レベルも意識しておく RESTful成熟度の3レベルモデルについて知る | NTT Communications Developer Portal https://developer.ntt.com/ja/blog/17762eeb-56e3-4977-acd7-9934f063f58b RESTとは何か。 - 自分の仕事を憎むには人生は余りにも短い http://garapon.hatenablog.com/entry/2016/10/17/REST%E3%81%A8%E3%81%AF%E4%BD%95%E3%81%8B%E3%80%82 RESTとは何か - Qiita https://qiita.com/aosho235/items/125af74e2eab66c7a816 レベル0〜3まであるが、現状3はあまり使われない。2まで考慮していれば十分 レベル2の理想的なAPIとして Amazon S3 が挙げられるらしい S3では以下のように、URLに名詞の名前を付けてリソースを区別し、メソッド（GET、POST、PUT、PATCH、DELETE）によって処理内容を区別している GET /puppy.jpg HTTP/1.1 ... 取得 PUT /puppy.jpg HTTP/1.1 ... 登録 DELETE /puppy.jpg HTTP/1.1 ... 削除 ■関連ツール 本当に使ってよかったOpenAPI (Swagger) ツール | Future Tech Blog - フューチャーアーキテクト https://future-architect.github.io/articles/20191008/ ■利用例 Swagger UI https://api.lawapi-prototype-test-elaws.e-gov.go.jp/ 法令APIプロトタイプ公開テスト｜デジタル庁 https://www.digital.go.jp/policies/legal-practice/public-test