前后端开发文档管理swagger

1.引入依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

2.运行程序

进入http://localhost:8081/swagger-ui/index.html
如配置security需要配置忽略

public void configure(WebSecurity web) throws Exception {
        web.ignoring().antMatchers("/index", "/login", "/swagger**/**", "/v3/**", "/webjars/**", "/doc.html");
    }

3.文档配置

@Configuration
public class SwaggerConfig {
    @Bean
    Docket docket() {
        return new Docket(DocumentationType.OAS_30)
                .select()
                .apis(RequestHandlerSelectors.basePackage("org.khm.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(
                        new ApiInfoBuilder()
                                .title("api测试文档")
                                .description("JJBlog")
                                .version("v1.0")
                                .contact(new Contact("khm", "http://www.khm.org", "khmerl@163.com"))
                                .license("Apache 2.0")
                                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0")
                                .build()
                );
    }
}

4.基本注解

标注用在哪些地方

    类:@Api(tags = "CategoryController")
    方法:@ApiOperation(value = "新增接口",notes = "新增类别")
    方法:@Operation(summary = "新增接口",description = "新增类别")
    方法:@ApiImplicitParam(name = "jjCategory",value = "path(路径),body(json),query(key-value)",required = true)
    参数:@ApiParam("页码")
    实体类:@ApiModel
    实体类属性:@ApiModelProperty(value = "cname",name = "类别名称")
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

康梓潼

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值