NotFound404 Not Found资源不存在

publicIHttpActionResultGet(){returnRedirect("https://www.example.com");}// 使用特定路由publicIHttpActionResultGet(){returnRedirectToRoute("DefaultApi",new{id =1});}

publicIHttpActionResultDelete(intid){_repository.Remove(id);returnStatusCode(HttpStatusCode.NoContent);// 返回 204 No Content}

publicIHttpActionResultGet(){if(!User.Identity.IsAuthenticated){returnUnauthorized();}returnOk();}

publicIHttpActionResultGet(){varresponse =Request.CreateResponse(HttpStatusCode.OK,"Custom Message");returnResponseMessage(response);}

publicIHttpActionResultGet(){vardata =new{Id =1,Name ="Example"};returnJson(data);}

publicIHttpActionResultPost(stringvalue){if(string.IsNullOrEmpty(value)){returnBadRequest("Value cannot be null or empty.");}returnOk();}

publicIHttpActionResultGet(){returnStatusCode(HttpStatusCode.NotImplemented);}

publicIHttpActionResult Get(){returnOk(newstring[]{"value1","value2"});}

[RoutePrefix("api/TestABC")]publicclassTestController:ApiController{[HttpGet][Route("GetValue")]// GET api/<controller>publicIEnumerable<string>Get(){returnnewstring[]{"value1","value2"};}}

/// <summary>/// 测试请求/// </summary>/// <returns>返回示例数据</returns>publicIEnumerable<string>Get(){returnnewstring[]{"value1","value2"};}

publicIHttpActionResultGet(intid){varitem =_repository.GetItem(id);if(item ==null){returnNotFound();}returnOk(item);}

@echo off:: 设置IIS Express的路径（通常位于Program Files中，如果安装在其他位置，请调整路径）setIIS_EXPRESS_PATH="C:\Program Files\IIS Express\iisexpress.exe":: 项目的物理路径，这条语句不需要修改，意为访问bat文件所在目录cd/d "%~dp0":: Web项目的端口setPORT=63027:: 项目的启动URL（如果需要）setURL=http://localhost:%PORT%/swagger/ui/index#/:: 打开默认浏览器访问URL（可选）start %URL%:: 启动IIS Express%IIS_EXPRESS_PATH% /path:"%cd%"/port:%PORT%pause

双击该bat文件即可将项目内容自动配置到IIS服务中。

7 一键启动

在项目的Web.config文件同目录下创建一个.bat文件

.bat文件的内容如下，相关信息修改为适合本项目的内容。NotFound404 Not Found资源不存在。

4.2 为程序添加注释

上文提到，勾选了生成“XML文档文件”，此xml是将写的注释记录下来。

将创建的swagger_lang.js在SwaggerConfig文件中进行引用。注意文件的路径。以下是常用的 IHttpActionResult实现及其对应的用途：

5.2.1 Ok

• 返回 HTTP 状态码：200 OK
• 用法：
  • 用于返回一个成功的响应，并可以附带一个对象作为响应体。

publicIHttpActionResultGet(){try{// 处理逻辑}catch(Exceptionex){returnInternalServerError(ex);}}

5.2.10 ResponseMessage

• 返回自定义的 HTTP 响应消息
• 用法：
  • 用于完全自定义 HTTP 响应，灵活构建响应消息。

    比如为Get请求添加注释。

    

    如果希望显示响应内容，可以使用特性标明。

    

    生成的内容如下：

    

    将“配置Swagger”中生成的xml文件拷到bin目录下，这是Swagger文档的基础，发布操作不会自动复制该文件，需要手动复制。

    

    发布位置选择“文件夹”。

publicIHttpActionResultPost(Itemitem){_repository.Add(item);returnCreated(newUri(Request.RequestUri +"/"+item.Id),item);}// 或者使用 CreatedAtRoute 指定路由名称publicIHttpActionResultPost(Itemitem){_repository.Add(item);returnCreatedAtRoute("DefaultApi",new{id =item.Id },item);}

5.2.7 NoContent

• 返回 HTTP 状态码：204 No Content
• 用法：
  • 用于表示请求已成功处理，但不需要返回响应体内容（例如更新操作）。

    

    类创建完成后，会自动生成示例程序，包含Get, Post, Put, Delete请求

    publicclassTestController:ApiController{// GET api/<controller>publicIEnumerable<string>Get(){returnnewstring[]{"value1","value2"};}// GET api/<controller>/5publicstringGet(intid){return"value";}// POST api/<controller>publicvoidPost([FromBody]stringvalue){}// PUT api/<controller>/5publicvoidPut(intid,[FromBody]stringvalue){}// DELETE api/<controller>/5publicvoidDelete(intid){}}

    启动项目，基于.Net Framework的web项目需要借助于服务启动，vs调试默认使用IIS服务。

    

    3 配置属性路由规则

    上文提到，配置类“WebApiConfig”中配置了默认路由规则，启用了属性路由。

publicIHttpActionResultPut(intid,Itemitem){if(!_repository.Update(id,item)){returnNotFound();}returnStatusCode(HttpStatusCode.NoContent);// 或者直接 NoContent()}

5.2.8 Redirect / RedirectToRoute

• 返回 HTTP 状态码：302 Found 或其他重定向状态码
• 用法：
  • 用于表示需要重定向到另一个 URI。

publicIHttpActionResultPost(Itemitem){if(_repository.Contains(item.Id)){returnConflict();}_repository.Add(item);returnOk();}

5.2.6 Created / CreatedAtRoute

• 返回 HTTP 状态码：201 Created
• 用法：
  • 用于表示资源已成功创建，并可以附带新资源的 URI。或者其他原因不得不使用.Net Framework开发web项目，可以参考本文。

    如果需要调用的项目是基于.Net Framework，那么web项目也应基于.Net Framework开发。

    

    5.2 其它方法

    除了常见的 Ok方法外，ASP.NET Web API 还提供了多个 IHttpActionResult的实现类或方法，用于构建特定的 HTTP 响应。

    /// <summary>/// 中文转换/// </summary>varSwaggerTranslator =(function(){//定时执行检测是否转换成中文,最多执行500次  即500*50/1000=25svariexcute =0,//中文语言包_words ={"Warning: Deprecated":"警告：已过时","Implementation Notes":"实现备注","Response Class":"响应类","Status":"状态","Parameters":"参数","Parameter":"参数","Value":"值","Description":"描述","Parameter Type":"参数类型","Data Type":"数据类型","Response Messages":"响应消息","HTTP Status Code":"HTTP状态码","Reason":"原因","Response Model":"响应模型","Request URL":"请求URL","Response Body":"响应体","Response Code":"响应码","Response Headers":"响应头","Hide Response":"隐藏响应","Headers":"头","Try it out!":"试一下！","Show/Hide":"显示/隐藏","List Operations":"显示操作","Expand Operations":"展开操作","Raw":"原始","can't parse JSON.  Raw result":"无法解析JSON. 原始结果","Model Schema":"模型架构","Model":"模型","apply":"应用","Username":"用户名","Password":"密码","Terms of service":"服务条款","Created by":"创建者","See more at":"查看更多：","Contact the developer":"联系开发者","api version":"api版本","Response Content Type":"响应Content Type","fetching resource":"正在获取资源","fetching resource list":"正在获取资源列表","Explore":"浏览","Show Swagger Petstore Example Apis":"显示 Swagger Petstore 示例 Apis","Can't read from server.  It may not have the appropriate access-control-origin settings.":"无法从服务器读取。Json任意状态码返回 JSON 响应内容。
    1 创建
    使用.Net做web后端，推荐使用.Net Core，微软在此基础上做了很多适配，包括内置Swagger，可以直接启动等等。然后将“一键启动”生成的.bat文件复制到Web.config文件同目录下，双击即可打开。
    publicIEnumerable<string>Get(){returnnewstring[]{"value1","value2"};}// GET api/<controller>/5publicstring Get(int id){return"value";}
    如果需要自主决定状态码或者返回错误结果内容时携带异常信息等，可以使用C#提供的IHttpActionResult接口。Conflict409 Conflict请求冲突（如违反约束）。
    在项目属性中，勾选生成“XML文档文件”，本质上是Swagger将此xml转换为Swagger格式的内容。NoContent204 No Content请求成功，但没有返回内容。

  

  2 测试

  项目创建完成后，并没有提供任何对外接口，添加一个测试接口。这里有一点，正常来说应该先启动IIS Express，再执行“浏览器访问URL”，但是启动IIS Express这个行为会阻塞到当前语句，不再往下执行，所以这里将“浏览器访问URL”语句提前，浏览器会等待IIS Express启动后访问成功。

publicIHttpActionResultGet(){vardata =new{Id =1,Name ="Example"};returnOk(data);}

5.2.2 BadRequest

• 返回 HTTP 状态码：400 Bad Request
• 用法：
  • 用于表示客户端发送的请求无效，例如参数验证失败或格式错误。

    打开VS，在搜索栏输入“ASP.NET Web”，选择.Net Framework版，注意，这里要创建的是空白API项目，在前后端分离的项目中只作为后端接口，而不是MVC（模型-视图-控制器）

    

    填写项目名，选择位置，选择需要的框架

    

    创建一个空白项目，勾选“Web API”，取消勾选“HTTPS配置”

    

    添加完成后，会创建以下目录结构：

    • “App_Data”目录用于方式一些资源文件；
    • “App_Start”目录下用于放置一些配置资源，默认已有一个配置类“WebApiConfig”，内容如下：

    publicstaticclassWebApiConfig{publicstaticvoidRegister(HttpConfigurationconfig){config.MapHttpAttributeRoutes();config.Routes.MapHttpRoute(name:"DefaultApi",routeTemplate:"api/{controller}/{id}",defaults:new{id =RouteParameter.Optional });}}

    - config.MapHttpAttributeRoutes();表示启用了属性路由，允许在控制器和操作方法上直接使用特性（如 [Route]）来定义路由规则。
    6 标明返回类型
    书接第五部分，返回类型如果使用IHttpActionResult接口，Swagger文档中无法解析出响应的具体内容，如下图所示。
    c.InjectJavaScript(thisAssembly,"TestWebApi.SwaggerUI.swagger_lang.js");//引用中文包
    汉化结果：
    5 包装返回结果
    5.1 IHttpActionResult接口
    默认生成的测试程序，请求到的数据都直接返回的数据内容。
    展开后，可以点击“Try it out”按钮进行测试。

publicIHttpActionResultGet(){try{thrownewInvalidOperationException("An unexpected error occurred.");}catch(Exceptionex){returnInternalServerError(ex);// 适用于返回异常信息的场景}}

5.2.14 NotImplemented

• 返回 HTTP 状态码：501 Not Implemented
• 用法：
  • 用于表示服务端还未实现某个功能。Created201 Created成功创建资源，并返回资源 URI。而.Net Framework版，需要手动配置很多内容。

    

    4 配置Swagger

    4.1 基本配置

    在NuGet中下载安装“Swashbuckle”

    

    安装完成后，在“App_Start”目录下会自动生成“SwaggerConfig”配置类。

    8 打包

    选择“发布”。在最后几行有“公司名称”和对应的Url，可以自行更改，这里我写了百度的链接作为测试。InternalServerError500 Internal Server Error服务器内部错误。

    /// <summary>/// swagger显示控制器的描述/// </summary>publicclassSwaggerControllerDescProvider:ISwaggerProvider{privatereadonlyISwaggerProvider_swaggerProvider;privatestaticConcurrentDictionary<string,SwaggerDocument>_cache =newConcurrentDictionary<string,SwaggerDocument>();privatereadonlystring_xml;/// <summary>/// /// </summary>/// <param name="swaggerProvider"></param>/// <param name="xml">xml文档路径</param>publicSwaggerControllerDescProvider(ISwaggerProviderswaggerProvider,stringxml){_swaggerProvider =swaggerProvider;_xml =xml;}publicSwaggerDocumentGetSwagger(stringrootUrl,stringapiVersion){varcacheKey =string.Format("_{1}",rootUrl,apiVersion);SwaggerDocumentsrcDoc =null;//只读取一次if(!_cache.TryGetValue(cacheKey,outsrcDoc)){srcDoc =_swaggerProvider.GetSwagger(rootUrl,apiVersion);srcDoc.vendorExtensions =newDictionary<string,object>{{"ControllerDesc",GetControllerDesc()}};_cache.TryAdd(cacheKey,srcDoc);}returnsrcDoc;}/// <summary>/// 从API文档中读取控制器描述/// </summary>/// <returns>所有控制器描述</returns>publicConcurrentDictionary<string,string>GetControllerDesc(){stringxmlpath =_xml;ConcurrentDictionary<string,string>controllerDescDict =newConcurrentDictionary<string,string>();if(File.Exists(xmlpath)){XmlDocumentxmldoc =newXmlDocument();xmldoc.Load(xmlpath);stringtype =string.Empty,path =string.Empty,controllerName =string.Empty;string[]arrPath;intlength =-1,cCount ="Controller".Length;XmlNodesummaryNode =null;foreach(XmlNodenode inxmldoc.SelectNodes("//member")){type =node.Attributes["name"].Value;if(type.StartsWith("T:")){//控制器arrPath =type.Split('.');length =arrPath.Length;controllerName =arrPath[length -1];if(controllerName.EndsWith("Controller")){//获取控制器注释summaryNode =node.SelectSingleNode("summary");stringkey =controllerName.Remove(controllerName.Length -cCount,cCount);if(summaryNode !=null&&!string.IsNullOrEmpty(summaryNode.InnerText)&&!controllerDescDict.ContainsKey(key)){controllerDescDict.TryAdd(key,summaryNode.InnerText.Trim());}}}}}returncontrollerDescDict;}}

    在SwaggerUI文件夹中，创建一个swagger_lang.js的js,用于对swagger进行汉化处理（注：这个文件必须添加，否则汉化将失败）

    swagger_lang.js 文件中的js内容如下。

    

    4.3 汉化处理

    安装“Swagger.Net.UI”

    

    安装完成后，在“App_Start”目录下新增了一个SwaggerNet类

    

    打开SwaggerNet类，注释掉这两行（这里我没做深究，参考的几篇文章都说注释掉这两行，可能后续运行有报错）

    

    创建一个“SwaggerControllerDescProvider”类，用于对swagger文档中的内容进行汉化处理。","Please specify the protocol for":"请指定协议：","Can't read swagger JSON from":"无法读取swagger JSON于","Finished Loading Resource Information. Rendering Swagger UI":"已加载资源信息。