はじめに OpenAPIとは SwaggerでAPIを設計する OpenAPIのフィールド openapi info externalDocs servers tags paths components おわりに はじめに こんにちは、山田です。最近少しだけ涼しいと感じる反面、シャーベット系のアイスにハマり始めています笑。 入社してから3ヶ月が経過して、ようやく慣れてきました。 本記事は入社して2本目の記事で、今回は研修で学んだAPIドキュメント作成の話です。研修ではショッピングサイトのAPI作成に取り組んだのですが、想像以上にドキュメント作成に苦戦をしたので整理もかねて書いています。 OpenAPIとは OpenAPIとは「OpenAPI Specification」の略でREST APIのコードやドキュメントを生成できるフォーマットのことを指します。API仕様書はExcelで作成すると
![ゼロからOpenAPIを始めた話 - NRIネットコムBlog](https://cdn-ak-scissors.b.st-hatena.com/image/square/7957053548d7af7abaf6461d370934c38c2ae630/height=288;version=1;width=512/https%3A%2F%2Fcdn-ak.f.st-hatena.com%2Fimages%2Ffotolife%2Fr%2Fr3-yamada%2F20230828%2F20230828174625.png)