1. 程式人生 > >OpenAPI 3.0.0 學習 之 老版本2.0通過Swagger Editor編寫介面文件

OpenAPI 3.0.0 學習 之 老版本2.0通過Swagger Editor編寫介面文件

PS:時間關係,先打一下草稿,日後整理相關細節。

Swagger線上編輯器(該款線上編輯器可以實現 json 與 yaml 轉換,一般推薦使用yaml):http://editor.swagger.io/

1. 首先準備一份字尾名為yaml的檔案,以下為內容:

swagger: "2.0"

info:
  version: 1.0.0
  title: Simple API
  description: A simple API to learn how to write OpenAPI Specification

schemes:
  - http
host: localhost:4010
basePath: /

paths:
  /user:
    get:
      summary: Gets some persons
      tags:
      - "user"
      
      description: Returns a list containing all persons. The list supports paging.
      produces: #這個一定要寫,不然瀏覽器顯示不出來
       - 'application/json'
      responses:
        200:
          description: A list of Person
          schema:
            type: array
            items:
              required:
                - ids
              properties:
                ids:
                  type: string
                username:
                  type: string
                password:
                  type: string
    

PS:example是寫給自己看的,資料都是自動隨機生成。自我感覺這樣測試資料非常好

2. 執行模擬器,swagger.yaml可以是json檔案

   

PS:起初沒有加cors,瀏覽器可以直接訪問,但是在Swagger Editor不能檢視生成的資料,加上cors就可以訪問,關於cors的資料日後再補充。

3.檢視生成的資料

PS:附上幾個學習OpenAPI好用的網站。