1. 程式人生 > >swagger 服務搭建

swagger 服務搭建

down uri 修改 sta link spa cal 初始 cnblogs

初始環境

  • 大於 Node 6.x
  • 大於 NPM 3.x
  • 需要把以下兩個包放部署在http服務下
    swagger-editor ( API 編輯 )
    swagger-ui ( API 查看 )

swagger-editor ( API 編輯 )

git clone https://github.com/swagger-api/swagger-editor.git
cd swagger-editor
npm install
npm run build
npm start
訪問 編輯頁面

http://localhost:8080/swagger-editor/index.html

swagger-ui ( API 查看 )

git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-editor
npm install
npm run build
npm start
訪問 查看頁面

http://localhost:8080/swagger-ui/dist/index.html
默認會引用 http://petstore.swagger.io/v2/swagger.json 這個api,有兩種可以修改默認訪問的方法:

  • 直接修改 swagger-ui/dist/index.html 文件中的 url 的值

    var swaggerUi = new SwaggerUi({
      url
    : 'http://petstore.swagger.io/v2/swagger.json', // url of specification dom_id: 'swagger-ui-container' //id of element where to render swagger-ui }); swaggerUi.load();
  • 通過query傳入url的值
    {your_host}/dist/index.html?url={specification_link}
    例如: http://localhost:8080/swagger-ui/dist/index.html?url=http://localhost:8080/rest/create.json

swagger 服務搭建