⑦Spring で REST APIのテンプレートとしてSwaggerを活用

REST には決まったパターンがあり、仕様に応じた修正コーディングが標準作業。
それ以降は Spring フレームワークに限らず様々なフレームワークでの対応がある。

ここで、話をSpring に限った場合、以下のような Spring initializer の利用が一般的で、初期テンプレートはそのまま作れる。https://spring.io/guides/gs/rest-service/

RESTの仕様記述の話。
元々Opan API ( https://swagger.io/specification/ ) という、REST APIを記述するドキュメント仕様( .yaml 形式 ) が標準化されていて、最初にこれをきっちり作るところが求められる。ここを Swagger (https://swagger.io/) というツール類のエディタで作り、次にツールでREST の標準パターンを自動生成するというもの。自動生成結果は更にて修正が必要だがそれは別途。

以下、代表的なサンプル。apiの肝として、path,  リソース操作仕様のGET/POST/PUT /PATCH(=リソースの部分更新)Pの記述のところ。responseコード

以下、検索指定無しの、全件取得のパターン
ここで、content: application/json: にいくつかあり、ここがポイント。
/pets:

    get:
        description: Returns all pets from the system that the user has access to
            responses:
           '200':
               description: A list of pets.
               content:
                   application/json:
                       schema:
                           type: array
                           items:
                               $ref: '#/components/schemas/pet'

 次に、この yaml 仕様自体を自動生成するオンラインツールが存在している。