ASP.NETコアのWeb APIを闊歩使用します

このセクションナビゲーション

闊歩はじめに
ASP.NET COREで闊歩の使用

ソフトウェア開発では、テストおよび管理APIは、重要かつ困難な作業です。私の記事の前に「R＆Dチームは、あなたのAPIドキュメントを気にしてください」また、一貫性のAPIドキュメントとコードを確保するために、文書管理ツールでコラボレーションをチームにそれほどより助長捧げました。

過去には、私たちはいつものようなサードパーティ製のプラットフォーム・ツールを通じて、私たちのAPIドキュメントを管理eolinker。テストでは、我々はシオマネキ、そのようなツールの郵便配達人を依存します。

闊歩両方のAPIドキュメントやテスト管理機能、およびコードとドキュメントの一貫性を確保。それはRESTfulAPIは、UIの任意の論理的に表現することなく達成提供します。これにより、ユーザーは、状況にアクセスするための任意のコードが存在しない状態での機能やサービスを理解するために、サービス文書を作成するための時間を短縮することができます。

1闊歩はじめに

闊歩闊歩使用ツールは、当社の書面によるサービスコード生成swagger.jsonファイルに基づいて、文書管理インターフェースを生成します。この文書では、それがどの程度のサポートサービスの方法であり、およびメソッドのパラメータに関する情報を提供し、サービスの機能について説明します。このファイルを使用して、SwaggerUIは、クライアントコードを生成します。ここでは例のswagger.jsonファイルです。

{
    "swagger": "2.0",
    "info": {
        "version": "1.0",
        "title": "My Demo API"
    },
    "paths": {
        "/api/Values": {
            "get": {
                "tags": ["Values"],
                "summary": "Get values",
                "operationId": "Get",
                "consumes": [],
                "produces": ["text/plain", "application/json", "text/json"],
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "Success",
                        "schema": {
                            "uniqueItems": false,
                            "type": "array",
                            "items": {
                                "type": "string"
                            }
                        }
                    }
                }
            },
            "post": {
                "tags": ["Values"],
                "operationId": "Post",
                "consumes": ["application/json-patch+json", "application/json", "text/json", "application/*+json"],
                "produces": [],
                "parameters": [{
                    "name": "value",
                    "in": "body",
                    "required": false,
                    "schema": {
                        "type": "string"
                    }
                }],
                "responses": {
                    "200": {
                        "description": "Success"
                    }
                }
            }
        }
    },
    "definitions": {}
}

APS.NETコアのWeb APIでは、我々は使用することができますSwashbuckle.AspNetCoreとNSwag闊歩を達成するために2つのパッケージを、そして両方がgithubの上のオープンソースです。また、nswagもtypescriptですクライアントコード生成方法およびAPIサービス・コードを提供します。

1.2 TPL

タスク並列ライブラリ（TPLは）一般的なタイプとAPIのSystem.ThreadingとSystem.Threading.Tasks名前空間のセットです。

TPLは、動的に利用可能なすべてのプロセッサの中で最も効果的に使用して、並行処理の度合いを拡張します。あなたのコードの実装のビジネスに焦点を当てながら、TPLを使用することにより、あなたは、コードのパフォーマンスを最大化することができます。

最初の.NET Framework 4から、TPLは、マルチスレッドと並列コードを書くための好ましい方法です。

ASP.NET COREで闊歩の2を使用します

ここでSwashbuckle.AspNetCoreに実現しています。

ここでASP.netコアのWeb APIで闊歩を設定する手順は、次のとおりです。

1.インストールSwashbuckle.AspNetCore

PM>インストール・パッケージSwashbuckle.AspNetCore

2. [設定闊歩ミドルウェア

真ん中を闊歩するには、要求パイプラインにswaggergen方法configureService方法スタートアップクラスを追加する必要性を追加しました。ここでは、一つ以上の闊歩するXML文書を定義することができます。

Startup.cs

// This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1.0", new Info { Title = "My Demo API", Version = "1.0" });
                c.IncludeXmlComments(System.IO.Path.Combine(System.AppContext.BaseDirectory, "ZhiKeCore.API.xml"));
            });
        }

このミドルウェアを有効にするには、我々はまた、メソッドは、メソッドの起動クラスを設定useswagger呼び出す必要があります。ここで、我々はまた、UIを生成するswagerendpointを設定する必要があります。useswagegrui swager.jsonファイルをロードするための静的ファイルミドルウェアを追加します。

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
                app.UseHsts();
            }

            app.UseHttpsRedirection();
            app.UseMvc();

            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1.0/swagger.json", "My Demo API (V 1.0)");
            });
        }

これらは、闊歩を構成するための基本的な手順であり、我々は開発環境で闊歩を開始するには、Visual Studioを使用したい場合は、少しセットを行う必要があります。セレクトアイテム-プロパティ-Debugには、ブラウザの起動（起動ブラウザ）闊歩の値を変更します。

利用シナリオ

我々はプログラムを開始したときに、次のインターフェイスを見ることができます：

利用シナリオ

私たちはここで見ると、そのHTTP動詞は、それぞれ異なるカラーコードに使用します。我々は、操作のいずれかの方法をクリックすると、それは我々が「非常に」ボタンをクリックしたときに、それがWeb APIにリクエストを送信し、より多くの情報パラメータを要求します。

私たちのWebAPIのテストでは、闊歩は、最小構成が必要とされる必要があります。

私たちはUIのコードのコメントに表示したいのであれば、それを行う方法をすべきですか？

.NETのコアでは、XMLのコメントを取得するには、プロジェクトのプロパティウィンドウの「ビルド」タブにある「XML文書ファイル」属性を設定することができます。

利用シナリオ

デフォルトでは、闊歩UIは、文書を表示しません。私たちは、パスがexmlcommentsが含まれて渡す必要があります。

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
       // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1.0", new Info { Title = "My Demo API", Version = "1.0" });
                c.IncludeXmlComments(System.IO.Path.Combine(System.AppContext.BaseDirectory, "ZhiKeCore.API.xml"));
            });
        }

利用シナリオ

参照

注意
マイクロチャンネル公衆番号に注意してくださいカイ二乗オフ。

利用シナリオ