swashbuckle

问题 I'm having a problem with Swashbuckle when hiding a call the definition of the model linked to the call remains in the definition in the JSON generated. Using the Document filter, I'm able to remove the call from the interface. The calls remain in the JSON generated but are invisible in Swagger UI. We can also see the definition for the Model and Enum linked to theses calls. Theses are internal calls and need to be hidden from external eyes in the JSON. How can I hide all the calls and their

问题 I have controller method with ObjectId params: [ProducesResponseType(200, Type = typeof(Test))] [HttpGet] [Route("{id}")] public IActionResult Get(ObjectId id) {... For this API method swagger generates a form with both of complex ObjectId model and string Id instead of single string param: How I can remove extra fields and keep only string Id? 回答1: Find out what answer from another story also adresses this issue: services.AddMvc(options => { ... options.ModelMetadataDetailsProviders.Add( new

问题 My swagger ui shows "Parameter content type" with various entries: "application/json-patch+json" , "text/json" , "application/json" , and "application/*+json" . I only want "application/json" . There's a similar unsolved issue on the repo, which uses this visual (older ui, but same idea): Is there some way to set this? Swashbuckle.AspNetCore version 4.0.1 Swashbuckle.AspNetCore.Filters version 4.5.5 回答1: Use the [Produces] and [Consumes] attributes. Swashbuckle (and others, like NSwag) will

问题 I have a C# web API that is using Swagger as API documentation. I have used the Swashbuckle packages. The swagger environment is working with multiple versions that i specify in the controllers. Today i introduced a new future version (1.2) that is still under development. I would like to open swagger on the version 1.1 version by default but still keep the correct sorting order in the dropdown in the top right (e.g. v1, v1.1, v1.2). Currently it always opens the top version in the drop down.

问题 You can add a comment on the methods like the example below but what about adding comments to the request and response model? /// <summary> /// my summary /// </summary> /// <remarks> /// remark goes here. /// </remarks> /// <param name="somepara">Required parameter: Example: </param> /// <return>Returns comment</return> /// <response code="200">Ok</response> 回答1: Yes just like Dimitar said, you can add comments to the responses with SwaggerResponse , the request is a bit different, just like

问题 You can add a comment on the methods like the example below but what about adding comments to the request and response model? /// <summary> /// my summary /// </summary> /// <remarks> /// remark goes here. /// </remarks> /// <param name="somepara">Required parameter: Example: </param> /// <return>Returns comment</return> /// <response code="200">Ok</response> 回答1: Yes just like Dimitar said, you can add comments to the responses with SwaggerResponse , the request is a bit different, just like

问题 Im using Swashbuckle v5.0.0 in a .net-core 2.1 application to generate my api-documentation. I've added this security definition: cfg.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme { Name = "oauth2", Type = SecuritySchemeType.OAuth2, Scheme = IdentityServerAuthenticationDefaults.AuthenticationScheme, Extensions = new Dictionary<string, IOpenApiExtension> { { "x-tokenName", new OpenApiString("token id_token") } }, Flows = new OpenApiOAuthFlows() { Implicit = new OpenApiOAuthFlow() {

问题 I ran into an issue on a project I am on where for various reasons we were unable to rely on swashbuckle to generate the swagger.json we needed for the project and had to write it ourselves by hand. I have been searching all over the place but have been unable to figure out how to configure it so that when people type /swagger in the home url, it defaults to my swagger.json file instead of the one auto-generated by swashbuckle that will not work for us. Users are forced to manually change to

问题 I'm trying to adjust the "displayName" of the model being used in an automatically generated Swagger definition. This will only affect the Swagger names, meaning the namespace in code would be left untouched, whilst when looking at the model from Swagger UI, you'd see a custom name. Currently, the model name being returned from code is a namespace and looks something like this: b.c.d.e.f , I would like to add an attribute to the code and "mask" the name for the Swagger docs, so that when the

问题 I created an asp.net webapi application which is using Individual Account Security so that the Bearer token is enabled by default. It's working fine so that I am able to test them in Postman without problem. Here comes the question when I'm trying to integrate the Swagger UI by Swashbuckle. I installed the Swashbuckle by: Install-Package Swashbuckle Then change the SwaggerConfig.cs : GlobalConfiguration.Configuration .EnableSwagger(c => { c.ApiKey("Token") .Description("Filling bearer token