swagger

Duplicate parameter output in Swagger

由 ↘锁芯ラ 提交于 2020-01-02 03:38:04
问题 Update: I'm starting to wonder if this is due to a bug: https://github.com/domaindrivendev/Swashbuckle/issues/590 But the workaround suggested there does not seem to solve my problem. I am using Swashbuckle to generate API documentation for a C# ASP.NET Web API project. My target is to allow the following as valid URL: /endpoint/items/123/foo?param2=bar With a required parameter (param1) set to "foo" and an optional parameter (param2) set to "bar". I would like both parameters contained

what is the equivalent of “startup.cs”(.Net Core) in my .Net framework application?

由 生来就可爱ヽ(ⅴ＜●) 提交于 2020-01-02 01:59:14
问题 Startup.cs has some methods which can be used to configure swagger to add file upload functionalities , now in which file in .NET Framework can i do the same functionalities? 回答1: As you said you want to configure Swagger in dot net framework so you need to install Swashbuckle just open package manager and type following commands Install-Package Swashbuckle -Version 5.6.0 then look in your App_Start file you will find SwaggerConfig.cs where you can configure it the minimum, you’ll need this

Asp.Net core Swashbuckle set operationId

由 |▌冷眼眸甩不掉的悲伤 提交于 2020-01-01 19:34:59
问题 How can I set swagger operationId attribute in Asp.Net Core 2.1 project? According to this post I should use SwaggerOperationAttribute but I cannot find it in Swashbuckle.AspNetCore library. Also there is an IOperationFilter public interface IOperationFilter { void Apply(Operation operation, OperationFilterContext context); } and I can't find any implementations for swagger generation purposes. 回答1: There are 2 other options without having to write any extra code or add extra dependency like

Listing API Methods Under Multiple Groups

由 扶醉桌前 提交于 2020-01-01 18:17:21
问题 I have Swashbuckle annotated code that looks like this: [Route("api/Subscribers/{id}/[controller]")] [Route("api/Organizations/{id}/[controller]")] public class AddressesController : Controller { [HttpGet("{aid}")] [SwaggerResponse(HttpStatusCode.OK, Type = typeof(PostalRecord))] public async Task<IActionResult> GetAddress(Guid id, Guid aid) { //do something } I would like to use the GroupActionsBy customization, as shown in this example, but I want to have the above GetAddress method

Swagger 入门

由 白昼怎懂夜的黑 提交于 2020-01-01 16:45:58
这是借鉴的公司的swagger 介绍 忽略元数据末尾 回到原数据开始处 在Maven中添加SpringFox依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.5.0</version> <scope>compile</scope> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.5.0</version> <scope>compile</scope> </dependency> 定义每个API @API表示一个开放的API，可以通过description简要描述该API的功能。比如下面的CustomerController，可以首先使用@API填写相关的描述信息。 除了必须的Description和Value外，@API可选元素还有： 限定符和类型 可选元素和说明 Authorization [] authorizations api的角色 java.lang.String basePath 适用于restful的路径描述 java.lang

Sending dynamic custom headers in swagger UI try outs

由 最后都变了- 提交于 2020-01-01 02:41:29
问题 I am using swagger in java. I am reading a header called callerId through requestAttributes in the code. I am not using the header through the annotation @HeaderParam. because of this reason, the header section is not showing up in the swagger UI for try outs. How can I make this header show up in the try out form. Is there any way I can achieve this without hard coding the header value. Thanks in advance. 回答1: You can add parameters to an operation using @ApiImplicitParams and

swagger codegen is overwriting my custom code in generated files

由 扶醉桌前 提交于 2019-12-31 22:01:06
问题 I used the swagger codegen to generate jaxrs server side classes and also client side java classes. This is the command I used to generate the classes java -jar modules/swagger-codegen-distribution/target/swagger-codegen-distribution-2.1.2-M1.jar -i /Users/me/Workspace/swagger-codegen/samples/yaml/echo.yaml -l jaxrs -o samples/server/echo/java The server code that was generated had a place holder to write my "magic". public Response echo(@ApiParam(value = "" )@HeaderParam("headerParam")

Unable to get Swagger UI working with Spring boot

由 北慕城南 提交于 2019-12-31 08:58:07
问题 I am trying to get Swagger UI working with Spring Boot 1.2.1. I followed the instructions at https://github.com/martypitt/swagger-springmvc and I added @EnableSwagger on my spring config. I currently get back JSON when I go to http://localhost:8080/api-docs but no nice HTML. I am using Maven and added the dependency on swagger-ui: <dependency> <groupId>org.ajar</groupId> <artifactId>swagger-spring-mvc-ui</artifactId> <version>0.4</version> </dependency> This is my complete list of

Swagger UI Displays but I get an “ERROR” indicator

由 时间秒杀一切 提交于 2019-12-31 01:39:06
问题 My swagger UI displays and it is showing all of my routes. Everything looks great except there is a big red ERROR indicator on the lower right. When I click it I get: { "schemaValidationMessages":[ { "level":"error", "message":"Can't read from file http://devxxxx.com:80/swagger/docs/v1" } ] } How do I fix this error? 回答1: That's the validator badge. The error is most likely because the on-line validator can't reach the OpenAPI spec on your server (devxxxx.com). I am assuming this server is

JSON-RPC Swagger combination

由 笑着哭i 提交于 2019-12-30 18:47:30
问题 I am considering to implement JSON-RPC for my web service with this library. I would also like to implement Swagger for my service. However, I am not sure, if these two are a good combination together. In JSON-RPC all methods are behind the same resource, while that does not make any sense in Swagger. I am wondering the following: Is it possible to combine these technologies in full strength? Is JSON-RPC still a good technology to use? Or is it better to implement it manually? Your thoughts
订阅 swagger