Microsoft.AspNetCore.Mvc.ApiExplorer Ruang nama
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Menyediakan jenis yang memungkinkan penemuan metadata seperti daftar pengontrol dan tindakan, dan URL-nya. Jenis-jenis ini berguna untuk mendokumeasi API menggunakan OpenAPI.
Kelas
| ApiConventionNameMatchAttribute |
Menentukan perilaku pencocokan metode atau parameter konvensi API berdasarkan nama. ApiConventionNameMatchBehavior untuk opsi yang didukung. . |
| ApiConventionResult |
Metadata yang terkait dengan metode tindakan melalui konvensi API. |
| ApiConventionTypeMatchAttribute |
Menentukan perilaku pencocokan parameter konvensi API berdasarkan jenis. ApiConventionTypeMatchBehavior untuk opsi yang didukung. . |
| ApiDescription |
Mewakili API yang diekspos oleh aplikasi ini. |
| ApiDescriptionExtensions |
Metode ekstensi untuk ApiDescription. |
| ApiDescriptionGroup |
Mewakili sekelompok api terkait. |
| ApiDescriptionGroupCollection |
Koleksi yang di-cache dari ApiDescriptionGroup. |
| ApiDescriptionGroupCollectionProvider |
Menyediakan akses ke koleksi ApiDescriptionGroup. |
| ApiDescriptionProviderContext |
Objek konteks untuk ApiDescription penyedia. |
| ApiParameterDescription |
Deskripsi metadata input ke API. |
| ApiParameterRouteInfo |
Deskripsi metadata informasi perutean untuk ApiParameterDescription. |
| ApiRequestFormat |
Format yang mungkin untuk isi permintaan. |
| ApiResponseFormat |
Format yang ApiResponseTypemungkin untuk . |
| ApiResponseType |
Kemungkinan jenis isi respons yang diformat oleh ApiResponseFormats. |
| DefaultApiDescriptionProvider |
Mengimplementasikan penyedia ApiDescription untuk tindakan yang diwakili oleh ControllerActionDescriptor. |
Antarmuka
| IApiDefaultResponseMetadataProvider |
Menyediakan jenis pengembalian untuk semua kode status HTTP yang tidak tercakup oleh instans lain IApiResponseMetadataProvider . |
| IApiDescriptionGroupCollectionProvider |
Menyediakan akses ke koleksi ApiDescriptionGroup. |
| IApiDescriptionGroupNameProvider |
Mewakili metadata nama grup untuk |
| IApiDescriptionProvider |
Menentukan kontrak untuk menentukan ApiDescription instans. |
| IApiDescriptionVisibilityProvider |
Mewakili metadata visibilitas untuk |
| IApiRequestFormatMetadataProvider |
Menyediakan informasi metadata tentang format permintaan ke |
| IApiRequestMetadataProvider |
Menyediakan sekumpulan jenis konten yang mungkin daripada yang dapat digunakan oleh tindakan. |
| IApiResponseMetadataProvider |
Menyediakan jenis pengembalian, kode status, dan sekumpulan kemungkinan jenis konten yang dikembalikan oleh keberhasilan eksekusi tindakan. |
| IApiResponseTypeMetadataProvider |
Menyediakan informasi metadata tentang format respons ke |
Enum
| ApiConventionNameMatchBehavior |
Perilaku untuk mencocokkan nama parameter atau metode konvensi. |
| ApiConventionTypeMatchBehavior |
Perilaku untuk mencocokkan jenis parameter konvensi. |
Keterangan
Untuk pengenalan Swagger (OpenAPI), ASP.NET dokumentasi API web Core dengan Swagger / OpenAPI.