Wei 技術分享

一、介紹 REST 是Roy Thomas Fielding博士於2000年博士論文提出的一種軟體架構風格，目的是讓不同軟體、程式於網路互相傳遞資訊。因為它是一種風格而不是規範，依據筆者的經驗會依照當時的專案或公司規定而決定是否完全遵守。 二、專案架構 圖、Visual Studio 2019 專案架構 三、常用的 HTTP Method 代表用意 GET 讀取 PUT 更新 DELETE 刪除 POST 新增 四、RESTful 路由應用 五、使用 Visual Studio 2019 建置 RESTful API 圖、修改 WebApiConfig.cs 原始碼(C#) public static class WebApiConfig { public static void Register(HttpConfiguration config) { // 針對 JSON 資料使用 camel 案例。 config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver(); // Web API 設定和服務 // Web API 路由 config.MapHttpAttributeRoutes(); config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{id}", defaults: new { id = RouteParameter.Optional } ); var appXmlType = config.Formatters.XmlFormatter.SupportedMediaTypes.FirstOrDefault(t => t.MediaType == ...

一、介紹 Postman 是筆者時常拿來用於測試 API 的工具，支援 Get、Post、Delete、Put…等 Http Request Method。 二、操作步驟 圖、開啟瀏覽器 輸入 網址 https://www.postman.com/downloads/ > 按下 Download the App 圖、安裝 圖、按下 Skip signing in and take me straight to the app 圖、按下 File > 按下 Settings 圖、設定 SSL certificat verification 為 OFF 三、使用 Get 請求 Json 格式資料 圖、按下 ＋ > 輸入你的 測試網址 > 按下 Send > 即可於下方看到 結果 四、使用 Post 送出 Json 格式的資料 圖、按下 ＋ > 選擇 POST > 輸入你的 測試網址 > 選擇 Body > 選擇 raw > 選擇 JSON > 輸入 你的 JSON 測試資料 > 按下 Send > 即可於下方看到 結果 五、相關連結 使用「Visual Studio 2019」建置一個有 Mvc 和 Web Api 架構的網站 六、參考 postman

一、介紹 NSwag 是一個 .net 、 .net core 下的 Swagger / OpenAPI 2.0 和 3.0 的工具，使用 JOSN 去描述 RESTful web API 。 二、Swagger Swagger 是一個介面描述語言使用 JSON 去描述 RESTful API 三、開發環境 整合開發環境：Visual Studio 2019 語言：C# .net framework：4.6.2 四、 Nuget NSwag.AspNet.Owin Microsoft.AspNet.WebApi.Owin 五、操作步驟 圖、建立 TestApiController.cs 原始碼 /// <summary> /// TestApiController summary /// </summary> public class TestApiController : ApiController { /// <summary> /// TestApi Get TestVm summary /// </summary> /// <param name="data"></param> /// <returns></returns> [HttpGet] public List<string> Get([FromUri]List<string> data) { return data; } } 圖、修改 Startup.cs 原始碼 var config = new HttpConfiguration(); app.UseSwaggerUi3(typeof(Startup).Assembly, settings => { settings.GeneratorSettings.DefaultUrlTemplate = "api/{controller}/{action}/{id?}"; }); app.UseWebApi(config); c...