月份: 2020 年 3 月

根據行業消息，蘋果近期與一家韓國電池開發商簽署了保密協議，聯合為代號為“泰坦”的汽車專案開發電池。從今年初開始，他們一直在韓國做行政工作。一名蘋果員工一直在這家韓國公司進行參觀活動，他屬於與蘋果電動汽車電池開發相關的部門。  
  業界認為，這家韓國公司並不是唯一一家負責蘋果電池開發的公司。不過，有消息稱，儘管蘋果從一開始就從完全不同的設計、功能以及性能角度來開發電池，但是他們仍舊一直在挖掘創新技術。業界相信，蘋果專注于開發出只能存在於蘋果自動駕駛汽車的創新電池技術。   這家韓國電池開發商由大約20名電池專家組成，持有空芯電池的國際專利技術。這些電池是圓柱形鋰離子二次電池，有兩根手指那麼厚，不同於其它空芯電池。蘋果並未選擇當前電動汽車普遍使用的標準圓形或矩形電池，但計畫根據韓國公司的空芯電池技術為其電動汽車開發自主電池。   文章來源：鳳凰科技

本站聲明:網站內容來源於EnergyTrend https://www.energytrend.com.tw/ev/,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】

※為什麼 USB CONNECTOR 是電子產業重要的元件?

※網頁設計一頭霧水??該從何著手呢? 找到專業技術的網頁設計公司，幫您輕鬆架站!

※想要讓你的商品成為最夯、最多人討論的話題?網頁設計公司讓你強力曝光

※想知道最厲害的台北網頁設計公司推薦、台中網頁設計公司推薦專業設計師”嚨底家”!!

　一.未使用Swagger狀況

　　相信無論是前端開發人員還是後端開發人員，都或多或少都被接口文檔折磨過，前端經常抱怨後端給的接口文檔或與實際情況不一致。後端又覺得編寫及維護接口文檔會耗費不少精力，經常來不及更新。 其實無論是前端調用後端，還是後端調用後端，都期望有一個好的接口文檔。但是這個接口文檔對於程序員來說，就跟註釋一樣，經常會抱怨別人寫的代碼沒有寫註釋，然而自己寫起代碼起來，最討厭的，也是寫註釋。 所以僅僅只通過強制來規範大家是不夠的，隨着時間推移，版本迭代，接口文檔往往很容易就跟不上代碼了

　二.使用Swagger狀況

　　Swagger 提供了一個可視化的UI頁面展示描述文件，其中包括接口的調用，接口所需參數（header,body,url.params），接口說明，參數說明等。接口的調用方、測試、項目經理等都可以在該頁面中對相關接口進行查閱和做一些簡單的接口請求。只要在項目框架搭建時，對Swagger 進行了配置，後面持續迭代的時候，只會花很小代價去維護代碼、接口文檔以及Swagger描述文件。因為一旦接口發生改變，程序重新部署，接口文檔會重新生成對應新的文檔。

　三.如何使用？

　　在NetCore項目中怎麼去使用Swagger來生成接口文檔呢？

　　首先在 webApi 啟動項目 上 右鍵 點擊管理Nuget程序包， 安裝  Swashbuckle.AspNetCore ，然後到  Startup 中添加引用  using Swashbuckle.AspNetCore.Swagger; 

　　在ConfigureServices方法中添加以下代碼

            #region Swagger

            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new Info
                {
                    Version = "v1",
                    Title = "API Doc",
                    Description = "作者:Levy_w_Wang",
                    //服務條款
                    TermsOfService = "None",
                    //作者信息
                    Contact = new Contact
                    {
                        Name = "levy",
                        Email = "levy_w_wang@qq.com",
                        Url = "https://www.cnblogs.com/levywang"
                    },
                    //許可證
                    License = new License
                    {
                        Name = "tim",
                        Url = "https://www.cnblogs.com/levywang"
                    }
                });

                #region XmlComments

                var basePath1 = Path.GetDirectoryName(typeof(Program).Assembly.Location);//獲取應用程序所在目錄（絕對，不受工作目錄(平台)影響，建議採用此方法獲取路徑）
                //獲取目錄下的XML文件 显示註釋等信息
                var xmlComments = Directory.GetFiles(basePath1, "*.xml", SearchOption.AllDirectories).ToList();

                foreach (var xmlComment in xmlComments)
                {
                    options.IncludeXmlComments(xmlComment);
                }
                #endregion

                options.DocInclusionPredicate((docName, description) => true);

                options.IgnoreObsoleteProperties();//忽略 有Obsolete 屬性的方法
                options.IgnoreObsoleteActions();
                options.DescribeAllEnumsAsStrings();
            });
            #endregion

上面寫的循環是因為項目中可能有多個控制器類庫，為的是排除這種情況

接下來，再到 Configure 方法中添加：

            #region Swagger

            app.UseSwagger(c => { c.RouteTemplate = "apidoc/{documentName}/swagger.json"; });
            app.UseSwaggerUI(c =>
            {
                c.RoutePrefix = "apidoc";
                c.SwaggerEndpoint("v1/swagger.json", "ContentCenter API V1");
                c.DocExpansion(DocExpansion.Full);//默認文檔展開方式
            });

            #endregion

這裏使用了 RoutePrefix  屬性，為的是改變原始打開接口文檔目錄，原始路徑為 swagger/index.html ,現在為 /apidoc/index.html 

這個時候在需要輸出註釋的控制器類庫的屬性 中設置如下信息，並添加上相關註釋

然後運行起來，打開本地地址加上  /apidoc/index.html  就可以看到效果，

特別提醒：如果打開下面這個界面能正常显示，但是提示  Fetch errorInternal Server Error v1/swagger.json  錯誤，說明有方法未指明請求方式，如 HttpGet HttpPost HttpPut 等，找到並指明，重新運行就正常了

  點擊方法右上角的 Try it out ，試下調用接口，然後點擊Exectue,執行查看結果，能得到後端方法返回結果就說明成功。

特別說明：有接口不需要展示出去的時候，可以在方法上添加屬性 Obsolete ，這樣就不會显示出來。 前提：有前面ConfigureServices中 後面的 忽略 有Obsolete 屬性的方法 設置才行！！！

 最後可以看到接口返回數據正常，並且也能看到接口響應請求嘛等等信息，一個接口應該返回的信息也都有显示。

總結：

本文從為開發人員手寫api文檔的痛楚，從而引申出Swagger根據代碼自動生成出文檔和註釋，

並且還可以將不需要的方法不显示等設置。然後進行了簡單的測試使用 。

但是！！一般後端方法都有token等驗證，需要在header中添加token、sid等字段來驗證用戶，保障安全性，

該設置將在下一章節中寫！

 下一章

以上若有什麼不對或可以改進的地方，望各位指出或提出意見，一起探討學習~

有需要源碼的可通過此 鏈接拉取 覺得還可以的給個 start 和點個 下方的推薦哦~~謝謝！

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理【其他文章推薦】

※為什麼 USB CONNECTOR 是電子產業重要的元件?

※網頁設計一頭霧水??該從何著手呢? 找到專業技術的網頁設計公司，幫您輕鬆架站!

※想要讓你的商品成為最夯、最多人討論的話題?網頁設計公司讓你強力曝光

※想知道最厲害的台北網頁設計公司推薦、台中網頁設計公司推薦專業設計師”嚨底家”!!