Swagger 不显示注解问题

.csproj添加下面配置

  <PropertyGroup>
    。。。。
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
    <NoWarn>$(NoWarn);1591</NoWarn>
  </PropertyGroup>

 

配置项作用
<GenerateDocumentationFile>启用 XML 文档生成(默认生成路径:bin/Debug/netX.X/项目名称.xml
<NoWarn>1591</NoWarn>忽略 CS1591 警告(未添加方法注释时的警告)

Swagger配置:

public static void AddSwaggerConfig(this IServiceCollection services){
    var basePath = AppContext.BaseDirectory;

     // 控制器注释文件(通常为项目名称.xml)
    var controllersXml = Path.Combine(basePath, "ZRAdmin.xml");
    c.IncludeXmlComments(controllersXml, true);
}

在使用Swagger进行API文档生成时,有时会出现注解显示API的问题。这可能是由多种原因导致的,以下是一些常见的原因和解决方法: 1. **Swagger配置问题**: - 确保在Spring Boot项目中已经正确配置了Swagger的配置类,并且配置类上有`@Configuration`和`@EnableSwagger2`注解。 - 检查`Docket` Bean的配置是否正确,特别是`basePackage`是否包含了你的Controller类所在的包。 2. **Controller类注解**: - 确保你的Controller类上有`@RestController`或`@Controller`注解,并且这些类在配置的`basePackage`中。 - 确保每个API方法上有`@RequestMapping`或其变体(如`@GetMapping`、`@PostMapping`等)注解。 3. **Swagger注解使用**: - 确保在API方法上使用了Swagger注解,如`@ApiOperation`、`@ApiResponses`和`@ApiParam`等。 - 检查这些注解的参数是否正确,特别是`value`和`notes`等描述性参数。 4. **依赖问题**: - 确保在`pom.xml`或`build.gradle`中正确添加了Swagger的依赖,并且版本兼容。 5. **缓存问题**: - 有时浏览器缓存会导致Swagger UI更新,尝试清除浏览器缓存或使用隐私模式重新加载Swagger UI。 以下是一个简单的Swagger配置示例: ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) .paths(PathSelectors.any()) .build(); } } ``` 确保你的Controller类位于`com.example.demo.controller`包下,并且方法上有适当的注解
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值