swagger2基本配置使用,生成文档,设置生产环境不启用

swagger是目前开发环境下主流的一种接口测试工具,并且可以生成swagger文档,省去了接口文档的操心事,当初这只能测试环境下用,上生产的时候我们可以选择不启用。

swagger2基本配置

上来第一步,导入依赖。

	<!-- 加在上面的properties里 -->
	<properties>
        <swagger.version>2.9.2</swagger.version>
        <swagger-models.version>1.5.21</swagger-models.version>
    </properties>
    
    <!-- swagger2相关依赖 -->
    <dependency>
       <groupId>io.swagger</groupId>
       <artifactId>swagger-models</artifactId>
       <version>${swagger-models.version}</version>
    </dependency>
	<dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger2</artifactId>
       <version>${swagger.version}</version>
    </dependency>
    <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger-ui</artifactId>
       <version>${swagger.version}</version>
    </dependency>

然后写一个swaggerConfig配置一下swagger。

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(Environment environment) {
        // 设置要显示swagger的环境
        Profiles of = Profiles.of("dev", "local");
        // 判断当前是否处于该环境
        // 通过 enable() 接收此参数判断是否要显示
        boolean b = environment.acceptsProfiles(of);

        return new Docket(DocumentationType.SWAGGER_2)
                .enable(b)
                .pathMapping("/")
                .select()
                //扫描范围
                .apis(RequestHandlerSelectors.basePackage("com.boot.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("标题")
                        .description("描述")
                        .version("版本1.0")
                        .license("执照")
                        .licenseUrl("自家的地址")
                        .build());
    }

}

当我上面的配置为dev,而没有local时,启动配置local的环境,就无法查看。如果把local加进去上面的配置中,就可以正常显示
在这里插入图片描述

生成文档

对了,文档并不是说给你生成一份word,而是这个页面就是api文档了,到时候直接把地址甩给你的前端即可,不过最好是甩个服务器上跑的项目的swagger,而不是你本地的

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger是一款流行的API设计工具,它可以帮助我们更轻松地设计、构建和测试API。Swagger2是Swagger的一个版本,它可以生成API接口文档,这样我们就可以更清晰地了解API的使用方法。 下面是使用Swagger2生成API接口文档的步骤: 1. 在项目中添加Swagger2依赖 在Maven项目中,可以在pom.xml文件中添加以下依赖: ``` <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> ``` 2. 配置Swagger2 在Spring Boot项目中,可以在application.properties或application.yml文件中添加以下配置: ``` # Swagger2配置 swagger2.enabled=true # 启用Swagger2 swagger2.title=API接口文档 # 文档标题 swagger2.description=API接口文档 # 文档描述 swagger2.version=1.0 # 文档版本 swagger2.basePackage=com.example.demo # 扫描的包路径 ``` 3. 编写API接口 在Spring Boot项目中,可以使用Spring MVC的注解来编写API接口,例如: ``` @RestController @RequestMapping("/api") @Api(tags = "用户管理") public class UserController { @GetMapping("/users") @ApiOperation("获取用户列表") public List<User> getUsers() { // TODO: 查询用户列表 return null; } @GetMapping("/users/{id}") @ApiOperation("根据ID获取用户") @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long") public User getUserById(@PathVariable Long id) { // TODO: 根据ID查询用户 return null; } @PostMapping("/users") @ApiOperation("创建用户") @ApiImplicitParam(name = "user", value = "用户信息", required = true, dataType = "User") public User createUser(@RequestBody User user) { // TODO: 创建用户 return null; } @PutMapping("/users/{id}") @ApiOperation("更新用户") @ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"), @ApiImplicitParam(name = "user", value = "用户信息", required = true, dataType = "User") }) public User updateUser(@PathVariable Long id, @RequestBody User user) { // TODO: 更新用户 return null; } @DeleteMapping("/users/{id}") @ApiOperation("删除用户") @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long") public void deleteUser(@PathVariable Long id) { // TODO: 删除用户 } } ``` 4. 访问Swagger2文档 在启动Spring Boot应用程序后,可以在浏览器中访问以下URL以查看Swagger2生成的API接口文档:http://localhost:8080/swagger-ui.html 在Swagger2的文档页面中,可以查看接口的详细信息,包括请求和响应的参数、请求方式、请求路径等。同时,我们也可以在页面中测试API接口。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值