The dokumentasi untuk memungkinkan integrasi xmldoc ke proyek-proyek Api Web Anda tampaknya hanya situasi pegangan di mana semua jenis API Anda adalah bagian dari proyek WebAPI Anda. Secara khusus, ini membahas cara mengubah rute dokumentasi XML ke App_Data/XmlDocument.xml
dan menghapus komentar baris di konfigurasi Anda yang akan menggunakan file itu. Ini secara implisit hanya memungkinkan untuk satu file dokumentasi proyek.
Namun, dalam pengaturan saya, saya memiliki jenis permintaan dan respons yang ditentukan dalam proyek "Model" umum. Ini berarti jika saya memiliki titik akhir yang ditentukan seperti:
[Route("auth/openid/login")]
public async Task<AuthenticationResponse> Login(OpenIdLoginRequest request) { ... }
Di mana OpenIdLoginRequest
didefinisikan dalam proyek C # terpisah seperti:
public class OpenIdLoginRequest
{
/// <summary>
/// Represents the OpenId provider that authenticated the user. (i.e. Facebook, Google, etc.)
/// </summary>
[Required]
public string Provider { get; set; }
...
}
Terlepas dari dokumen XML, properti request
parameter tidak berisi dokumentasi saat Anda melihat halaman bantuan khusus titik akhir (yaitu http://localhost/Help/Api/POST-auth-openid-login
).
Bagaimana cara membuatnya sehingga jenis subproyek dengan dokumentasi XML muncul di dokumentasi Web API XML?
sumber
var files...
baris denganvar files = Directory.GetFiles(documentPath, "*.xml");
jika Anda (seperti saya) tidak selalu tahu nama / jumlah file dokumentasi xml yang akan ada di sana. Bisa juga melakukan penyaringan lebih lanjut sesuai kebutuhan.Saya mengalami ini juga, tetapi saya tidak ingin mengedit atau menduplikasi kode apa pun yang dihasilkan untuk menghindari masalah nanti.
Berdasarkan jawaban lain, berikut adalah penyedia dokumentasi mandiri untuk berbagai sumber XML. Letakkan saja ini ke dalam proyek Anda:
... dan aktifkan di Anda
HelpPageConfig
dengan path ke dokumen XML yang Anda inginkan:sumber
Satu cara yang lebih sederhana untuk melakukan ini adalah dengan menggabungkan file xml. Contoh kode di balasan saya di bawah ini:
Komentar XML Halaman Bantuan Web Api dari lebih dari 1 file
sumber
di sini saya memberikan tautan jawaban dengannya, yang dapat membantu Anda. Anda dapat dengan mudah menggunakan beberapa file XML untuk dokumentasi.
Komentar XML Halaman Bantuan Web Api dari lebih dari 1 file
sumber
Cara termudah untuk memperbaiki masalah ini adalah membuat folder App_Code di server yang Anda gunakan. Kemudian salin XmlDocument.xml yang Anda miliki di folder bin Anda secara lokal ke folder App_Code
sumber