swagger

问题 In my Azure Mobile .NET backend I want to use Azure Mobile .NET Server Swagger . I'm looking for fast way to hide swagger UI from public access ? Is there any way to provide access only for selected users ? 回答1: First a disclaimer: Even if you protect your Swagger UI from public consumption, you are not protecting your APIs from public consumption. You have to assume that everyone knows all of your routes and have the appropriate security in place to protect any requests that may come in.

问题 I follow the instructions by https://github.com/domaindrivendev/Swashbuckle.AspNetCore create a new asp.net core web api project add nugget package Swashbuckle.AspNetCore Add code for swagger services.AddSwaggerGen(options => { options.SwaggerDoc("v1", new Info { Version = "v1", Title = "API (version 1.0)", Description = "A RESTFUL API" }); options.IncludeXmlComments(xmlDocPath); }); app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "API"); }); Add code

问题 I want to documenting a REST API with Swagger and Spring MVC, And I find out that Spring 3 only can use Swagger V1 <artifactId>swagger-springmvc</artifactId> <version>1.0.2</version> when I add @ApiParam in front of @RequestBody , do not display completely in Data Type. Finally I choose Swagger V2 in Spring 4 I add some dependency and change, as below . <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> <artifactId>spring-web</artifactId> <artifactId>4.1.6.RELEASE<

问题 Is there a way in swagger to show example data for; model, both input & output, query parameters, headers, etc? I have been unable to find anything related to this in the annotations documentation; https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X 回答1: If you look at the documentation for some of the annotations mentioned in the wiki you will see they have among their optional parameters one called example or examples . You can use this parameter to add a single example or

问题 When trying to incorporate swagger into my API I'm running into some issues. My API is using Jersey 2.22 and the language is Scala. I've added the following dependencies to my pom: <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-annotations</artifactId> <version>1.5.12</version> </dependency> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-scala-module_2.11</artifactId> <version>1.0.3</version> </dependency> My plugin is configured as follows: <plugin> <groupId

问题 I have a Web Api 2 project that has an HttpGet method that takes a list of complex objects as the parameter. Like this: [HttpGet] public string GetCoolStuff(List<ContainerContract> containers) I am using swashbuckle to setup my swagger docs. But it sets this parameter up like this: { "name" : "containerContracts", "in" : "query", "required" : true, "type" : "array", "items" : {}, "collectionFormat" : "multi" } At the very least the items object seems like it needs something in it. Later down

问题 I have my pojo defined, @ApiModelProperty(hidden=true) @JsonIgnore public Set<Tank> getTankSet() { return tankSet; } But still I see following json definition in the swagger doc; "tankSet" : { "type" : "array", "items" : { "$ref" : "Tank" }, Which causes Swagger UI loading issue "swagger.js:744 Uncaught TypeError: Cannot read property '$ref' of undefined". How can i overcome this issue? Edit POJO @JsonIgnore @ApiModelProperty(hidden=true) public Set<Tank> getTankSet() { return tankSet; } Pom

问题 For some reason when I deploy my API using Restler's API Explorer (a fork of Swagger UI) to production it gives me a general 404 error when I load: /api/explorer When I am more explicit and state: /api/explorer/index.html It loads the framing for the page but then reports "404 : Not Found ../resources.json" in red text below the header: I'm fairly certain there's something environmental flaring up as the same files locally work. I also checked the .htaccess file in the /api/explorer directory

问题 I am not Maven´s user and i want configure all dependencies of Swagger in my project. I try make it unsucessful. I get thousands jars, jackson- , swagger- and nothing. 回答1: From https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-JAX-RS-Project-Setup-1.5.X#adding-the-dependencies-to-your-application: Projects that cannot utilize maven's dependencies would need to add the dependencies manually. Since those may change from version to version, the list of dependencies will not be

问题 I've been following this guide to create developer friendly documentation for my ASP.Net REST WebApi using Swashbuckle. However, the current version Swashbuckle.AspNetCore v2.2.0 generates a huge single page app, which is confusing for my users. If I remember correctly, Swashbuckle was generating separate pages for each controller/method (early 2017?). My configuration looks like this: app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "API V1"); c.EnableFilter(); c