Appreciate, respect and accept it, don't take it for granted

在本機瀏覽Open API格式的文件

2021-08-06
software_development
open_api/redoc/swagger

Open API類似原始資料, 可以使用ReDoc或是Swagger UI其中之一呈現

若有使用vs code的話可以直接安裝擴充功能: OpenAPI (Swagger) Editor

若想要放在內部機器上可以使用docker

1
git clone git@github.com:j2hongming/open_api.git

docker-compose.yaml內容如下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
version: '3'
services:
  redoc:
    image: redocly/redoc
    ports:
      - 8888:80
    volumes:
      - ./api.yaml:/usr/share/nginx/html/api.yaml
    environment:
      - SPEC_URL=/api.yaml
  swagger:
    image: swaggerapi/swagger-ui
    ports:
      - 8080:8080
    volumes:
      - ./api.yaml:/api.yaml
    environment:
      - SWAGGER_JSON=/api.yaml

參考

Blog comments powered by Disqus