springboot2集成api文檔工具swagger-ui(上)

一凡碼農 2020-01-13 10:10:39
說明第一步:創建項目

浏覽器打開:https://start.spring.io/,生成一個spring boot項目 

點擊Generate這個按鈕,下載項目包文件

第二步:導入開發工具

打開下載目錄,解壓項目文件

啓動idea,引入項目文件

第三步:引入swagger-ui包

<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency>    <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>

第四步:創建一個swagger 配置

@EnableSwagger2@Configurationpublic SwaggerConfig {    @Bean    public Docket api(){        return new Docket(DocumentationType.SWAGGER_2)                .apiInfo(apiInfo())                .select()                .apis(RequestHandlerSelectors.basePackage("com.shelton.swaggerui"))                .build();    }    public ApiInfo apiInfo(){        return new ApiInfoBuilder()                .title("api接口說明")                .version("1.0.0")                .build();    }}

第五步:創建一個POST api接口

@RestController@Api(value = "用戶接口", tags={"用戶操作接口"})public IndexController {    @ApiOperation(value = "用戶登錄",notes = "登錄",httpMethod = "POST")    @PostMapping("/login")    public Object get(@RequestParam @ApiParam(name="username",value="登錄賬號",required=true) String username, @RequestParam @ApiParam(name="password",value="密碼",required=true) String password){        Map map = new HashMap();        map.put("msg","success");        map.put("code","1");        return map;    }}

頁面效果圖 

測試api接口請求 

這裏返回的結果,可以看到,跟我們預期返回的是一樣。

總結
0 阅读:325

一凡碼農

簡介:專業分享開發技術知識