标签: swagger

我尝试将Swagger与Microsoft WebAPI 2 一起使用.

目前,我在一个方法中进行了以下调用.

appBuilder
   .ConfigureOAuth()
   .UseWebApi(configuration)
   .UseWelcomePage();

如果我想使用Swagger,我必须使用这个URL" https:// localhost:44300/swagger "哪一个非常好用.

我希望我的主页重定向到我的招摇的网址,也许如下,但这个示例不起作用.

    appBuilder
       ...
       .UseWelcomePage("/swagger");

任何的想法 ？

有没有办法使用Swagger在Flask中生成RESTful API ？

我正在使用java spring boot框架为我的项目创建REST api,我使用"springfox-swagger2和springfox-swagger-ui"来生成swagger文档.我可以使用url http:// localhost:8080/swagger-ui.html查看我的文档.

如何创建或生成swagger.json/spec.json,文档不应该与此应用程序一起使用我们使用单独的应用程序列出api文档

这是我的理解:

• Swagger是编写文档的符号/规则.但为什么它被称为框架(如Angular/MVC)？
• Swashbuckle是一个程序(JavaScript？),它生成文档(基于Swagger规则).
• Swagger UI显示文档.它使用Swashbuckle来做到这一点.

这些信息是否正确？如果没有,有人能用简单的术语解释什么是Swagger,Swashbuckle和Swashbuckle UI意味着什么？

另外,如果我不使用它,我作为API开发人员会失去什么？

我希望使用Swagger记录我的restful接口.问题是我不想通过注释我的代码来自动生成我的文档.基本上我不想将我的内部数据模型耦合到接口公开的虚拟数据模型.看来我可以让我的服务器提供一个Resources.json文件,然后为每个资源处理程序提供相应的JSON文件.但是,当我尝试这个时,我试图定义JSON正确的语法并提供正确的HTTP头响应字段时遇到了很多小问题.

有没有人用这种方式使用Swagger？有人有一些文件或例子吗？我能找到的所有内容都只是使用客户端库为您生成内容.

我必须记录我的API.我必须使用其中任何一个Slate或Swagger.我想知道哪一个有更多选择,优点和缺点,哪一个更好.

我使用Java中的JAX-RS/Jersey开发了我的REST API.我想为它转换为/生成基于Swagger的UI文档.任何人都可以告诉我精确/步骤简单的方法如何这样做？对不起,但他们网站上的步骤对我来说有点模糊.

我正在使用Swagger(1.5.8).我希望我的swagger.json定义能够在我的DTO上检测javax.validation JSR-303注释,以便我可以记录我的API的验证约束.

我希望@Min注释(如本例)会显示最小值(44),但事实并非如此.

@POST
@ApiOperation(value = "post", httpMethod = "POST")
public Response post(
        @QueryParam("id") @NotNull @Min(44) Integer id) {...}

结果swagger.json是:

"/foo": {
  "post": {
    "operationId": "post",
    ...
    "parameters": [
      {
        "in": "body",
        "name": "id",
        "description": "id",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32"
        }
      }

Swagger 关闭了此功能的pull请求,但我不清楚它在Swagger定义中的使用位置和方式.

我希望能够做到这样的事情:

FooController的

@POST
public void postFoo(@Valid @RequestBody FooDTO fooDto) {...}

FooDTO

public class FooDTO {
    @NotNull
    @Size(min = 1, max = …

我正在ASP.NET Core 1.0中创建一个REST api.我正在使用Swagger进行测试,但现在我为某些路线添加了JWT授权.(带UseJwtBearerAuthentication)

是否可以修改Swagger请求的标头,以便[Authorize]可以测试具有该属性的路由？

我已经创建了一个 RESTful API，现在正在为该 API 的使用定义 Open API 3.0 JSON 表示形式。

当存在另一个参数时，我需要有条件地使用一个参数。所以我不能真正使用required: trueorrequired: false因为它需要有条件。我是否应该将其定义为required: false，然后在summary和/或 中description说在使用其他参数时需要它？或者有没有办法定义参数之间的依赖关系？我在规格中没有发现任何提及此类案例的内容。