Swagger

Swaggerとは

RESTfulAPIにおけるインターフェイスのフォーマット

Swagger Spec

Swagger書式によるAPI仕様書
yaml、jsonで保存

※swagger.yaml
swagger: "2.0"
info:
 title: "API(例)"
 description: "公開API一覧"
 version: "1.0.0"

paths:
#ユーザー画面
 /api/method1:
  get:
   tags:
     - Method1 API
   description: "Method1の機能説明"
   
   parameters:
    - name: "lease_type_ids"
     description: "パラメータの説明"
     required: true
     type: "string"
     
   responses:
    "200":
     description: "Method1正常時の挙動説明"
     schema:
      title: ArrayOfPosts
      type: array
      items:
       title: Posts
       type: object
       properties:
        name:
         type: string
        title:
         type: string
    "404":
      description: "検索結果が0件"
      schema:
       type: "object"
       properties:
        code:
         type: "string"
         example: "E999"
 /api/method2:
  〜

Swagger Editor

SwaggerSpecファイルをブラウザ上で編集するツール

Swagger UI

SwaggerSpecファイルをブラウザ上で表示するツール

http://{ホスト名}/swagger/index.html

Swagger Codegen

Swagger Specで記載された設計からクライアント/サーバコードを生成するコマンドラインツール
多くの言語、フレームワークに対応

Follow me!

前の記事

WordPress Basic認証

次の記事

Laravel Homestead