自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

利用Swashbuckle生成Web API Help Pages

作者：朱成林
開發(fā) 開發(fā)工具
Swashbuckle有兩個核心組件：Swashbuckle.SwaggerGen: 提供生成描述對象，方法，返回類型等JSON Swagger文檔的功能。Swashbuckle.SwaggerUI: 一個Swagger UI工具的嵌入式版本，可以使用上面的文檔來創(chuàng)建可定制化的Web API的功能描述，包含內(nèi)置的公共方法的測試工具。

[[189063]]

Swashbuckle簡介

Swashbuckle有兩個核心組件：

  • Swashbuckle.SwaggerGen: 提供生成描述對象，方法，返回類型等JSON Swagger文檔的功能。
  • Swashbuckle.SwaggerUI: 一個Swagger UI工具的嵌入式版本，可以使用上面的文檔來創(chuàng)建可定制化的Web API的功能描述，包含內(nèi)置的公共方法的測試工具。

在middleware中添加并配置Swagger

首先,要將Swashbuckle添加到項目中的project.json：

  1. "Swashbuckle": "6.0.0-beta902" 

然后在Configure方法中添加SwaggerGen到services集合中，接著在ConfigureServices方法中，允許中間件(middleware)為生成的JSON文檔和SwaggerUI提供服務(wù)。

執(zhí)行dotnet run命令，并導(dǎo)航到http://localhost:5000/swagger/v1/swagger.json 查看描述終結(jié)點的文檔。

  1. 在middleware中添加并配置Swagger 
  2. 首先,要將Swashbuckle添加到項目中的project.json： 
  3.  
  4. "Swashbuckle": "6.0.0-beta902" 
  5. 然后在Configure方法中添加SwaggerGen到services集合中，接著在ConfigureServices方法中，允許中間件(middleware)為生成的JSON文檔和SwaggerUI提供服務(wù)。 
  6.  
  7.  
  8.  
  9. 執(zhí)行dotnet run命令，并導(dǎo)航到http://localhost:5000/swagger/v1/swagger.json 查看描述終結(jié)點的文檔。 
  10.  
  11. { 
  12.   "swagger": "2.0", 
  13.   "info": { 
  14.     "version": "v1", 
  15.     "title": "API V1" 
  16.   }, 
  17.   "basePath": "/", 
  18.   "paths": { 
  19.     "/api/User": { 
  20.       "get": { 
  21.         "tags": [ 
  22.           "User" 
  23.         ], 
  24.         "operationId": "ApiUserGet", 
  25.         "consumes": [], 
  26.         "produces": [ 
  27.           "text/plain", 
  28.           "application/json", 
  29.           "text/json" 
  30.         ], 
  31.         "responses": { 
  32.           "200": { 
  33.             "description": "Success", 
  34.             "schema": { 
  35.               "type": "array", 
  36.               "items": { 
  37.                 "$ref": "#/definitions/UserItem" 
  38.               } 
  39.             } 
  40.           } 
  41.         }, 
  42.         "deprecated": false 
  43.       }, 
  44.       "post": { 
  45.         "tags": [ 
  46.           "User" 
  47.         ], 
  48.         "operationId": "ApiUserPost", 
  49.         "consumes": [ 
  50.           "application/json", 
  51.           "text/json", 
  52.           "application/json-patch+json" 
  53.         ], 
  54.         "produces": [], 
  55.         "parameters": [ 
  56.           { 
  57.             "name": "item", 
  58.             "in": "body", 
  59.             "required": false, 
  60.             "schema": { 
  61.               "$ref": "#/definitions/UserItem" 
  62.             } 
  63.           } 
  64.         ], 
  65.         "responses": { 
  66.           "200": { 
  67.             "description": "Success" 
  68.           } 
  69.         }, 
  70.         "deprecated": false 
  71.       } 
  72.     }, 
  73.     "/api/User/{id}": { 
  74.       "get": { 
  75.         "tags": [ 
  76.           "User" 
  77.         ], 
  78.         "operationId": "ApiUserByIdGet", 
  79.         "consumes": [], 
  80.         "produces": [], 
  81.         "parameters": [ 
  82.           { 
  83.             "name": "id", 
  84.             "in": "path", 
  85.             "required": true, 
  86.             "type": "string" 
  87.           } 
  88.         ], 
  89.         "responses": { 
  90.           "200": { 
  91.             "description": "Success" 
  92.           } 
  93.         }, 
  94.         "deprecated": false 
  95.       }, 
  96.       "put": { 
  97.         "tags": [ 
  98.           "User" 
  99.         ], 
  100.         "operationId": "ApiUserByIdPut", 
  101.         "consumes": [ 
  102.           "application/json", 
  103.           "text/json", 
  104.           "application/json-patch+json" 
  105.         ], 
  106.         "produces": [], 
  107.         "parameters": [ 
  108.           { 
  109.             "name": "id", 
  110.             "in": "path", 
  111.             "required": true, 
  112.             "type": "string" 
  113.           }, 
  114.           { 
  115.             "name": "item", 
  116.             "in": "body", 
  117.             "required": false, 
  118.             "schema": { 
  119.               "$ref": "#/definitions/UserItem" 
  120.             } 
  121.           } 
  122.         ], 
  123.         "responses": { 
  124.           "200": { 
  125.             "description": "Success" 
  126.           } 
  127.         }, 
  128.         "deprecated": false 
  129.       }, 
  130.       "delete": { 
  131.         "tags": [ 
  132.           "User" 
  133.         ], 
  134.         "operationId": "ApiUserByIdDelete", 
  135.         "consumes": [], 
  136.         "produces": [], 
  137.         "parameters": [ 
  138.           { 
  139.             "name": "id", 
  140.             "in": "path", 
  141.             "required": true, 
  142.             "type": "string" 
  143.           } 
  144.         ], 
  145.         "responses": { 
  146.           "200": { 
  147.             "description": "Success" 
  148.           } 
  149.         }, 
  150.         "deprecated": false 
  151.       }, 
  152.       "patch": { 
  153.         "tags": [ 
  154.           "User" 
  155.         ], 
  156.         "operationId": "ApiUserByIdPatch", 
  157.         "consumes": [ 
  158.           "application/json", 
  159.           "text/json", 
  160.           "application/json-patch+json" 
  161.         ], 
  162.         "produces": [], 
  163.         "parameters": [ 
  164.           { 
  165.             "name": "item", 
  166.             "in": "body", 
  167.             "required": false, 
  168.             "schema": { 
  169.               "$ref": "#/definitions/UserItem" 
  170.             } 
  171.           }, 
  172.           { 
  173.             "name": "id", 
  174.             "in": "path", 
  175.             "required": true, 
  176.             "type": "string" 
  177.           } 
  178.         ], 
  179.         "responses": { 
  180.           "200": { 
  181.             "description": "Success" 
  182.           } 
  183.         }, 
  184.         "deprecated": false 
  185.       } 
  186.     }, 
  187.     "/api/Values": { 
  188.       "get": { 
  189.         "tags": [ 
  190.           "Values" 
  191.         ], 
  192.         "operationId": "ApiValuesGet", 
  193.         "consumes": [], 
  194.         "produces": [ 
  195.           "text/plain", 
  196.           "application/json", 
  197.           "text/json" 
  198.         ], 
  199.         "responses": { 
  200.           "200": { 
  201.             "description": "Success", 
  202.             "schema": { 
  203.               "type": "array", 
  204.               "items": { 
  205.                 "type": "string" 
  206.               } 
  207.             } 
  208.           } 
  209.         }, 
  210.         "deprecated": false 
  211.       }, 
  212.       "post": { 
  213.         "tags": [ 
  214.           "Values" 
  215.         ], 
  216.         "operationId": "ApiValuesPost", 
  217.         "consumes": [ 
  218.           "application/json", 
  219.           "text/json", 
  220.           "application/json-patch+json" 
  221.         ], 
  222.         "produces": [], 
  223.         "parameters": [ 
  224.           { 
  225.             "name": "value", 
  226.             "in": "body", 
  227.             "required": false, 
  228.             "schema": { 
  229.               "type": "string" 
  230.             } 
  231.           } 
  232.         ], 
  233.         "responses": { 
  234.           "200": { 
  235.             "description": "Success" 
  236.           } 
  237.         }, 
  238.         "deprecated": false 
  239.       } 
  240.     }, 
  241.     "/api/Values/{id}": { 
  242.       "get": { 
  243.         "tags": [ 
  244.           "Values" 
  245.         ], 
  246.         "operationId": "ApiValuesByIdGet", 
  247.         "consumes": [], 
  248.         "produces": [ 
  249.           "text/plain", 
  250.           "application/json", 
  251.           "text/json" 
  252.         ], 
  253.         "parameters": [ 
  254.           { 
  255.             "name": "id", 
  256.             "in": "path", 
  257.             "required": true, 
  258.             "type": "integer", 
  259.             "format": "int32" 
  260.           } 
  261.         ], 
  262.         "responses": { 
  263.           "200": { 
  264.             "description": "Success", 
  265.             "schema": { 
  266.               "type": "string" 
  267.             } 
  268.           } 
  269.         }, 
  270.         "deprecated": false 
  271.       }, 
  272.       "put": { 
  273.         "tags": [ 
  274.           "Values" 
  275.         ], 
  276.         "operationId": "ApiValuesByIdPut", 
  277.         "consumes": [ 
  278.           "application/json", 
  279.           "text/json", 
  280.           "application/json-patch+json" 
  281.         ], 
  282.         "produces": [], 
  283.         "parameters": [ 
  284.           { 
  285.             "name": "id", 
  286.             "in": "path", 
  287.             "required": true, 
  288.             "type": "integer", 
  289.             "format": "int32" 
  290.           }, 
  291.           { 
  292.             "name": "value", 
  293.             "in": "body", 
  294.             "required": false, 
  295.             "schema": { 
  296.               "type": "string" 
  297.             } 
  298.           } 
  299.         ], 
  300.         "responses": { 
  301.           "200": { 
  302.             "description": "Success" 
  303.           } 
  304.         }, 
  305.         "deprecated": false 
  306.       }, 
  307.       "delete": { 
  308.         "tags": [ 
  309.           "Values" 
  310.         ], 
  311.         "operationId": "ApiValuesByIdDelete", 
  312.         "consumes": [], 
  313.         "produces": [], 
  314.         "parameters": [ 
  315.           { 
  316.             "name": "id", 
  317.             "in": "path", 
  318.             "required": true, 
  319.             "type": "integer", 
  320.             "format": "int32" 
  321.           } 
  322.         ], 
  323.         "responses": { 
  324.           "200": { 
  325.             "description": "Success" 
  326.           } 
  327.         }, 
  328.         "deprecated": false 
  329.       } 
  330.     } 
  331.   }, 
  332.   "definitions": { 
  333.     "UserItem": { 
  334.       "type": "object", 
  335.       "properties": { 
  336.         "key": { 
  337.           "type": "string" 
  338.         }, 
  339.         "name": { 
  340.           "type": "string" 
  341.         }, 
  342.         "age": { 
  343.           "format": "int32", 
  344.           "type": "integer" 
  345.         } 
  346.       } 
  347.     } 
  348.   }, 
  349.   "securityDefinitions": {} 
  350. } 

該文檔用來驅(qū)動Swagger UI，可以導(dǎo)航http://localhost:5000/swagger/ui來查看Swagger UI。

 

在UserController里面的每個方法都可以在該頁面上通過點擊”Try it out!”進行測試。

定制&擴展

API描述信息

  1. services.ConfigureSwaggerGen(options => 
  2. { 
  3.     options.SingleApiVersion(new Info 
  4.     { 
  5.         Version = "v1", 
  6.         Title = "User Web API", 
  7.         Description = "ASP.NET Core Web API", 
  8.         TermsOfService = "None", 
  9.         Contact = new Contact { Name = "Charlie Chu", Email = "charlie.thinker@aliyun.com", Url = "http://zhuchenglin.me/" }, 
  10.         License = new License { Name = "The MIT License", Url = "http://zhuchenglin.me/" } 
  11.     }); 
  12. }); 

XML注釋

通過在project.json添加“xmlDoc”: true來啟用XML注釋。

ApplicationBasePath獲取該應(yīng)用的根路徑，它必須為XML注釋設(shè)置一個完整的路徑，生成的XML注釋名稱基于你的應(yīng)用程序的名稱。

注意這個界面是通過之前生成的JSON文件來驅(qū)動的，所有的這些API描述信息和XML注釋都會寫入到這個文件中。

【本文為51CTO專欄作者“朱成林”的原創(chuàng)稿件，轉(zhuǎn)載請聯(lián)系原作者】

戳這里，看該作者更多好文

責(zé)任編輯：武曉燕 來源： 51CTO專欄
SwashbuckleWeb API Help Pages核心
相關(guān)推薦

2024-10-17 16:12:08

2024-04-28 18:28:12

API文檔生成工具開發(fā)Web API

2011-04-15 09:20:56

ASP.NET MVC

2011-12-23 09:28:31

Java

2009-04-13 11:38:27

IBMdWWeb

2023-07-26 17:13:38

2009-06-15 15:43:54

Stripes實現(xiàn)Ja

2020-11-04 13:18:34

WebAPIWeb Share A

2011-10-27 16:24:48

API

2011-09-16 14:21:47

Web API

2016-10-18 10:23:14

Docker容器SSL證書

2019-11-13 11:52:46

區(qū)塊鏈API比特幣

2014-08-12 10:28:08

AngularJS外部API

2012-04-25 11:21:41

Visual Stud

2009-06-23 16:52:16

JSFHibernateWeb應(yīng)用

2010-09-15 12:15:23

NessusWEB應(yīng)用安全掃描

2017-02-14 21:15:48

2011-01-20 10:17:25

ibmdwWeb

2024-07-22 17:21:05

2012-06-20 14:34:03

jQuery
點贊
收藏

51CTO技術(shù)棧公眾號