文章正文

springboot集成Swagger与使用swagger-ui-layer自定义UI界面

【文章】2021-10-22

简介springboot集成Swagger与使用swagger-ui-layer自定义UI界面

  • pom.xml 引入jar包

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>com.github.caspar-chen</groupId>
    <artifactId>swagger-ui-layer</artifactId>
    <version>1.1.3</version>
</dependency>

  • 添加配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket ProductApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .genericModelSubstitutes(DeferredResult.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(false)
                .pathMapping("/")
                .select()
                .build()
                .apiInfo(productApiInfo());
    }

    private ApiInfo productApiInfo() {
        ApiInfo apiInfo = new ApiInfo("XXX系统数据接口文档",
                "文档描述。。。",
                "1.0.0",
                "API TERMS URL",
                "联系人邮箱",
                "license",
                "license url");
        return apiInfo;
    }
}

  • 在controller类添加

@RestController
@RequestMapping
//Api注解，描述信息 可通过tag进行分类
@Api(value = "HelloController", description = "HelloController")
public class HelloController {
    @PostMapping("/addPerson")
    //方法描述
    @ApiOperation(notes = "添加人员", value = "addPerson")
    public Person addPerson(
            @ApiParam(name = "name", value = "姓名") @RequestParam("name") String name,
            @ApiParam(name = "age", value = "年龄")  @RequestParam("age") Integer age) {
        Person person = new Person();
        person.setAge(age);
        person.setName(name);

        return repository.save(person);
    }
}

  • 预览api地址

http://ip:port/docs.html 
http://ip:port/swagger-ui.html

  • 常用的swagger注解（http://docs.swagger.io/swagger-core/apidocs/index.html）

打赏支持

感谢您的支持，加油!

打开微信扫码打赏，你说多少就多少

找书费时，联系客服快速查找!

扫码支持

在线客服8:30-22:30，若离线请留言！

获取教程，请联系在线客服!

扫码支持

在线客服8:30-22:30，若离线请留言！

热门阅读

找PDF电子书，太费时间?

  • 微信扫描二维码，让客服快速查找。

    • 在线客服8:30-22:30，若离线请留言！

    PDF电子书