Swagger是遵守OpenAPI規范(OAS)的世界上最大的API框架開發工具,可在整個API生命周期內進行開發,從設計和文檔到測試和部署。它提供了許多試用的工具來幫助開發者進行接口開發,如及時接口文檔編寫工具swagger-editor,前端展示swagger-ui,還有代碼自動生成工具swagger-codegen。
下面會分別對這些工具進行介紹,由於Swagger的版本更新較快,功能愈發強大,所以我選擇了使用swagger2進行整合,並且使用java語言進行示例。
swagger-codegen自動生成代碼工具的介紹與使用 --生成客戶端代碼
功能強大的swagger-editor的介紹與使用 --生成API文檔,兼生成服務端代碼
swagger-ui生成api文檔並進行測試 --API文檔和接口測試
如果,你只是想在你的java spring工程里使用swagger,那么你可以直接看這篇文章
Spring Boot中使用Swagger2構建強大的RESTful API文檔
如果,你覺得swagger原生的ui風格不好看,想換換風格,你可以看這篇文章
Swagger 自定義UI界面
標准
OAS標准(OpenAPI規范標准) https://www.jianshu.com/p/5365ef83252a