2016-03-30 68 views
3

我創造上的Visual Studio 2015年的Azure的API應用程序時,我打的瀏覽和重定向到http://localhost:3012/如果我添加swagger到URL沒有任何反應:http://localhost:3012/swagger如何查看招搖UI爲天青API應用程序

似乎我需要爲完整地址添加/ docs/v1:http://localhost:3012/swagger/docs/v1。當我添加/放大器來加載swagger頁面時,不應該像自動URL路由一樣。 此外,我只能夠查看json架構,如果我瀏覽到UI http://localhost:3012/swagger/ui頁面不加載。

API應用程序成功建立。有什麼遺漏嗎?

回答

1

佩德羅線路中的註釋,上面提供了一個完美的答案爲使SwaggerUi。 至於你有關的URL「swagger/docs/v1

這是使用Swashbuckle當你在一個項目中安裝Swashbuckle包返回揚鞭2.0 JSON元數據創建

SwaggerConfig.cs文件API的默認URL問題。您可以在文件夾「App_Start」中找到它。它提供了許多配置Swashbuckle的方法。我沒有檢查您是否可以更改該默認網址或對其進行網址重新路由。

編輯:爲揚鞭文檔和招搖的UI

默認路由模板 「招搖/文檔/ {} apiVersion」 和 「招搖/ UI/{*} assetPath」 分別。只要提供的模板包含相關的路由參數 - {apiVersion}和{* assetPath},您就可以更改這些參數。 例如:swagger-ui的URL將爲myswag/index。

httpConfiguration .EnableSwagger( 「文檔/ {apiVersion} /招搖」 中,c => c.SingleApiVersion( 「V1」, 「A爲API標題」))

.EnableSwaggerUi(「myswag/{*} assetPath「);

你可以在GitHub庫閱讀更多關於它在這裏:https://github.com/domaindrivendev/Swashbuckle

2

在您的WebAPI項目(文件夾App_Start中的SwaggerConfig.cs)的配置中,您必須啓用Swagger UI。它被視爲默認行爲。

只需打開配置,請搜索:

   /* 
        }) 
       .EnableSwaggerUi(c => 
        { 
       */ 

和禁用上方,其下

0

如果您正在創建使用模板API Azure的API應用程序在Visual Studio中,你只需要從SwaggerConfig未註釋幾行.cs文件爲您的API應用程序激活Swagger。

  1. 在您的解決方案查找文件 'SwaggerConfig.cs'

    'VSSolution'> App_Start> SwaggerConfig。CS

  2. 查找EnableSwaggerUi和刪除留言給下面的代碼

      /* 
           }) 
          .EnableSwaggerUi(c => 
           { 
          */ 
    
  3. 就是這樣,沒有其他的配置要求一致。

    只要運行該應用程序: http://localhost:57452/招搖

+0

請妥善格式化你的代碼。 –

+0

sry,現在格式化! –