Swagger w/ASP.NET v5 Azure Api App

Question

我正在尝试使用Swagger + Swashbuckle设置Api应用程序(Azure),如Scott Hanselman在// Build会议上所示:http://channel9.msdn.com/Events/Build/2015/2-628.

我已经安装(使用NuGet)包Swagger.Api和Swashbuckle.Core.它没有添加任何我想要的控制器或设置,以便有一个昂首阔步的页面.当我导航到{baseUrl}\swagger时,我收到404错误.

我认为,由于它有一个UI,除了Api应用程序之外还需要一个Web应用程序,但是我已经重新编写了演示,Scott明确表示你可以在任何Api应用程序中添加Swagger + Swashbuckle.在第二个应用程序中,虽然我认为Api发现可能存在问题.有没有人成功设置过这个？

Answer 1

时间流逝,现在Swashbuckle适用于vNext(对我来说也是beta8,也可能是其他版本) - 感谢团队和贡献者!

在project.json中添加包:

    "Swashbuckle": "6.0.0-*",

在ConfigureServices()中的startup.cs中:

        services.AddSwaggerGen();
        services.ConfigureSwaggerDocument(options =>
        {
            options.SingleApiVersion(new Info
            {
                Version = "v1",
                Title = "My Super API",
                Description = "A Super API using Swagger and Swashbuckle",
                TermsOfService = ""
            });

        });
        services.ConfigureSwaggerSchema(options =>{
            options.DescribeAllEnumsAsStrings = true;
        });

在Configure()中的startup.cs中:

        app.UseSwaggerGen();
        app.UseSwaggerUi();

现在您可以访问您的API doco - http:// domain:port/swagger/ui/index.html

访问您的Swagger定义 - http:// domain:port/swagger/v1/swagger.json

然后假设您至少有一个面向dev/uat/staging/prod环境的互联网,抓住定义URL,然后在http://editor.swagger.io/上执行文件 - >导入URI - 现在你有大约20个代码客户也:)

您也可以设置自己的代码生成服务器(https://github.com/swagger-api/swagger-codegen),但我利用现有的在线生成器.在线编辑器还具有完整的模型和关系的定义过于至少在我的情况下我完全定义使用EF7我的模型(我知道,ICK ...但它大大优于<= EF6和ServiceStack不支持CoreCLR,尚) .根据项目的大小,这可以为您节省几个小时到几周的工作文档,而且在您编写更多代码时它会自动动态更新.你也可以用它来测试你的终端,但我还是喜欢PostMan.

完整示例项目,请访问https://github.com/mrsheepuk/ASPNETSelfCreatedTokenAuthExample/tree/beta8

MrSheepUK的大热门

HTH

Answer 2

这个答案现在已经过时了。请参阅另一个答案。

有一篇很好的博文描述了您遇到的问题：https://alexanderzeitler.com/articles/Deploying-a-ASP-NET-MVC-6-API-as-Azure-API-App-in-Azure-App-Services /

这描述了如何添加啊嘿！打包到 ASP.NET v6 Web Api 项目并将其作为 API 应用程序添加到 Azure。

这是另一个来源：http://devmeetsbi.ghost.io/help-and-test-page-for-asp-net-web-api-asp-net-5-and-mvc-6/