您好,登錄后才能下訂單哦!
這篇文章將為大家詳細講解有關(guān)SpringBoot使用knife4j實現(xiàn)在線調(diào)試接口的方法,文章內(nèi)容質(zhì)量較高,因此小編分享給大家做個參考,希望大家閱讀完這篇文章后對相關(guān)知識有一定的了解。
knife4j
knife4j是為Java MVC
框架集成Swagger
生成Api
文檔的增強解決方案,前身是swagger-bootstrap-ui,
具有小巧,輕量,并且功能強悍的優(yōu)點。
Knife4j
提供兩大核心功能:文檔說明 和 在線調(diào)試
文檔說明:根據(jù)Swagger
的規(guī)范說明,詳細列出接口文檔的說明,包括接口地址、類型、請求示例、請求參數(shù)、響應(yīng)示例、響應(yīng)參數(shù)、響應(yīng)碼等信息,使用swagger-bootstrap-ui
能根據(jù)該文檔說明,對該接口的使用情況一目了然。
在線調(diào)試:提供在線接口聯(lián)調(diào)的強大功能,自動解析當(dāng)前接口參數(shù),同時包含表單驗證,調(diào)用參數(shù)可返回接口響應(yīng)內(nèi)容、headers
、Curl
請求命令實例、響應(yīng)時間、響應(yīng)狀態(tài)碼等信息,幫助開發(fā)者在線調(diào)試,而不必通過其他測試工具測試接口是否正確,簡潔、強大。
SpringBoot使用knife4j進行在線接口調(diào)試
注入依賴
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>2.0.4</version> </dependency>
SwaggerConfig.class :knife4j配置類
@Configuration @EnableSwagger2 @EnableKnife4j @Import(BeanValidatorPluginsConfiguration.class) public class SwaggerConfig { /** * 這里配置swagger掃描的包 * @return */ @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors .basePackage("com.luo.producer")) .paths(PathSelectors.any()).build(); } /** * 這里配置swagger對外提供服務(wù)的端口 * @return */ private ApiInfo apiInfo() { return new ApiInfoBuilder().title("發(fā)布模擬boos接口") .description("簡單優(yōu)雅的發(fā)布模擬boos接口restful風(fēng)格接口") // .termsOfServiceUrl("http://127.0.0.1:8080/doc.html") .version("1.0").build(); } }
驗證
測試接口
@RestController @Slf4j public class UserController { @GetMapping("/helloword") public String hello(String input){ return "你好,"+input; } }
啟動項目后:訪問http://127.0.0.1:8080/doc.html
訪問測試接口,進行測試:
關(guān)于SpringBoot使用knife4j實現(xiàn)在線調(diào)試接口的方法就分享到這里了,希望以上內(nèi)容可以對大家有一定的幫助,可以學(xué)到更多知識。如果覺得文章不錯,可以把它分享出去讓更多的人看到。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。