springmvc結合自動生成api接口文檔

HTML Java 可視化 技術 輕芒521 輕芒521 2017-09-27

利用框架

Swagger

官網:http://swagger.io/

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

使用方法:

首先你得有自己的一個能訪問的api代碼,一個簡單的demo就可以,然後我們開始添加代碼

1.maven依賴:

springmvc結合自動生成api接口文檔

2.我們在代碼中添加SwaggerConfig配置類:

[java]view plaincopy

springmvc結合自動生成api接口文檔

這裡得有一個注意的地方, @EnableWebMvc註解,在網上的大部分代碼中都沒有這個註解,小編做的時候也遇到了很大的麻煩,會報SwaggerConfig類不能自動裝載,加上了這個就好了,具體用法大家想了解的自行查找。

3.springMVC配置文件中加上這段代碼:

[html]view plaincopy

springmvc結合自動生成api接口文檔

4.添加測試類:

[html]view plaincopy

springmvc結合自動生成api接口文檔

springmvc結合自動生成api接口文檔

springmvc結合自動生成api接口文檔

springmvc結合自動生成api接口文檔

springmvc結合自動生成api接口文檔

加上之後重啟程序,別的機器訪問,可以了 ,裡邊可以看接口列表並且可以接口測試,爽呆了:

但是要注意,這裡的配置是允許所有的ip訪問,這樣會相應的出現安全問題

相關推薦

推薦中...