1. 程式人生 > >swagger-ui教程 構建api介面文件工具

swagger-ui教程 構建api介面文件工具

1.在我第一次開發app後端的時候,使用的word文件,就是我先將所有資料格式定義好,會返回什麼樣的資料寫好。前端人員照這個來進行開發。貼一張圖吧:
這裡寫圖片描述

PS:存在的問題:①介面改動時,不易被識別。②維護困難,不便於查詢。③前端開發不能進行測試。(如果還要寫缺點,有5K+字可以寫出來,就省略了哈)

2.在我開發第二個APP的後端時,先自己寫了一個簡易的app介面管理系統,用來後端釋出介面,以及前端人員檢視。效果如圖:

這裡寫圖片描述

PS:優點:①如果有多個前端人員,可以保證大家看到的是同一份文件。②通過介面的版本標識,方便大家檢視是否修改,優點等等省略。缺點:①不能夠進行線上介面測試,需要藉助poster外掛。
現在給大家要推薦下我利用一天時間改造的swagger-ui的中文版了。本來英文就非常好了,只是為了瞭解一下這個東東,順手給他改成中文版了,也做為自己第一個github的專案吧。還是先上效果圖吧:
介面模組介面:
這裡寫圖片描述

介面列表介面:
這裡寫圖片描述

某個介面介面:
這裡寫圖片描述
OK,貼圖到此為止啦,如果還沒有看夠的同學,給你們一個連線,自己去試試:
swagger-ui中文版地址:http://helei112g.github.io/swagger-ui/

相信經過剛剛的體驗,不需要我說它的強大與便利了吧?不僅僅可以通過它立即進行線上測試,還可以根據返回的json它自動構建成model。便於你做決策。好處我就不說了,反正自從用了它,我們的前端腰不酸,腿也不痛了。寫起程式碼來也精神了。

相關推薦

swagger-ui教程 構建api介面工具

1.在我第一次開發app後端的時候,使用的word文件,就是我先將所有資料格式定義好,會返回什麼樣的資料寫好。前端人員照這個來進行開發。貼一張圖吧: PS:存在的問題:①介面改動時,不易被識別。②維護困難,不便於查詢。③前端開發不能進行測試。(如果還要寫

swagger 生成 PHP restful API 介面

需求: 為客戶端同事寫介面文件的各位後端同學,已經在各種場合回憶了使用自動化文件工具前手寫文件的血淚史. 我的故事卻又不同,因為首先來說,我在公司是 Android 組負責人,屬於上述血淚史中催死人不償命的客戶端陣營. 但血淚史卻是相通的,沒有自動化文件的日子,對介面

Swagger UI教程 API 神器 搭配Node使用 web api 介面 mvc介面

兩種方案 一、Swagger 配置 web Api 介面文件美化 二、通過NodeJS 釋出Swagger UI 配置api 文件 先說一下簡單的 Swagger 配置 web Api  Swagger-UI本身只提供線上測試功能,要整合它還需要告訴它本專案提供的各

Swagger 生成 PHP API 介面

Swagger 生成 PHP API 介面文件 標籤(空格分隔): php 1、概況 有同學反饋寫幾十個介面文件需要兩天的工作量, 隨著多部門之間的協作越來越頻繁, 維護成本越來越高, 文件的可維護性越來越差, 需要一個工具來管理這些介面的文件, 並能夠充當mock server給呼叫方使用。 有

整合swagger2生成Restful Api介面 webapi描述-swagger

整合swagger2生成Restful Api介面文件 swagger Restful文件生成工具 2017-9-30 官方地址:https://swagger.io/docs/specification/about/ 官方Github:https://github.com/swagger-

Spring Cloud Zuul中使用Swagger彙總API介面

有很多讀者問過這樣的一個問題:雖然使用Swagger可以為Spring MVC編寫的介面生成了A

.NET Core使用swagger進行API介面管理

一、問題背景   隨著技術的發展,現在的開發模式已經更多的轉向了前後端分離的模式,在前後端開發的過程中,聯絡的方式也變成了API介面,但是目前專案中對於API的管理很多時候還是通過手工編寫文件,每次的需求變更只要涉及到介面的變更,文件都需要進行額外的維護,如果有哪個小夥伴忘記維護,很多時候就會造

Swagger解決你手寫API介面的痛

    首先,老規矩,我們在接觸新事物的時候, 要對之前學習和了解過的東西做一個總結。 01 痛     苦 不做、不行   之前,前後端分離的系統由前端和後端不同的編寫,我們苦逼的後端工程師會把自己已經寫完的API介面,寫一個介面文件給到我們前端工程師,

Swagger2整合springBoot,自動生成API介面

Swagger2整合springBoot 首先匯入jar包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swa

API介面說明

API文件規範要求 一、 寫明該介面的功能是什麼 二、 請求的URL是什麼 三、 請求方式是什麼(POST、GET、 DELETE、PUT、 PATCH等) 四、 引數是什麼,此處還需說明你的引數名、引數型別、是否必填、引數的簡單解釋 五、 請求成功時的響應內容(實際開發中,要與前端同事溝通

Swagger2 快速定義API介面

引入依賴 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0&

Spring專案整合apidoc生成api介面

一、背景需求  JavaWeb/spring專案寫成的api介面,需要自動生成api文件,甚至需要線上測試介面。考慮實現的方案有swagger,apidoc,spring rest docs。在之後的專案都有一一嘗試,最終還是覺得apidoc的方式比較合適,雖然有一些問題(針對線上

springboot中使用swagger2構建restful介面

最近幾年網際網路專案、移動應用越來越多,不同於之前的企業內部應用,該類專案通常就是好幾個應用互相呼叫,我們一般會使用word或者excel來記錄介面的相應描述,但是這樣會有一些問題,比如更新困難,不易管理。 Swagger 是一款RESTFUL介面的文件線上自動生成+功能測試功能軟體,它既能

好用的API介面推薦總結

我是做服務端開發的,經常需要些介面文件,以前用過txt,word,感覺體驗太差了。網上找過很多,下面給大家總結一下。 易文件應該是我用過體驗最好的線上介面文件,專門優化過的http文件編輯和預覽頁面,編寫很方便,預覽很漂亮,還支援線上介面除錯。另外還有一些很方便的小功能,感覺用了就回不去了。 Showdo

Jersey2+swagger組建restful風格api管理

1.jar包引入 <dependency> <groupId>org.glassfish.jersey.core</groupId> <artifactId>jersey-server<

如何優雅的“編寫”api介面

前言  今天我需要把之前寫的介面整理成文件,老大給了意見用swagger搞,我像發現新大陸一樣的興奮,迫不及待得去“佔有”它。   Swagger很容易上手,我花了十幾分鍾就搞定了。正好接著之前的如何優雅的格式化介面,這裡再說一下SpringBoot整合Swagger的簡單過

bigemap百度離線地圖API介面介面呼叫例項

    1.當前版本支援百度電子地圖瓦片和百度衛星地圖瓦片; 2.效果預覽演示地址:http://www.bigemap.com/bmap  後臺編輯體驗地址:http://www.bigemap.com/bmap/ 可隨意在後臺新增/修改標註

Swagger+Spring mvc生成Restful介面

簡介 Swagger 是一個規範和完整的框架,用於生成、描述、呼叫和視覺化 RESTful 風格的 Web 服務。總體目標是使客戶端和檔案系統作為伺服器以同樣的速度來更新。檔案的方法,引數和模型緊密整合到伺服器端的程式碼,允許API來始終保持同步。Swagger 讓部署管理和使用功能強大的API從未如此簡

【流程規範】API介面規範

介面名稱 前置主動還款申請(/payBill) 介面描述 返回格式:json 請求方式:GET/ POST 介面備註:根據傳入的key和qq號碼發起還款的申請 請

[Swagger] 利用Gradle外掛解析 swagger.json 並生成靜態介面

[Swagger] 利用Gradle外掛解析 swagger.json 並生成靜態介面文件 利用Gradle外掛解析 swagger.json 並生成靜態介面文件 目錄結構 |- capsule-static-doc |- docs |- as