Anteriormente, usaba webapi para proporcionar interfaces en el proyecto, y descubrí que en el proyecto hay generación automática de documentos de ayuda según los métodos y comentarios de webapi, y también puedes probar métodos webapi, que son muy potentes, y ahora los compartiré contigo.
Echa un vistazo primero a la documentación generada de webapi.
1. La siguiente figura muestra la página superior del documento de ayuda de generación, donde Values es el controlador, y la lista debajo de la API muestra el método http (Get, POST, etc.), la acción de la solicitud y la descripción del método.
2. Haz clic en el enlace del recuadro rojo para abrir la página de detalles del método API, como se muestra en la figura de abajo.
3. Haz clic en la API de prueba para abrir la siguiente página
4. Introduce los parámetros, haz clic en el botón Enviar, abre la página siguiente y podrás ver el valor de retorno.
Los pasos para configurarlo son los siguientes:
Entorno de desarrollo VS2012 + MVC4 + API WEB
1. Referencia al cliente de prueba de la API web a través de NuGet
Referenciar la DLL generará un archivo así:
Esta es nuestra interfaz de documentación de ayuda
2. Haz los siguientes ajustes en las propiedades del proyecto, revisa el archivo del documento XMl y establece la ruta
3. Crear un XmlDocument.xml bajo la carpeta App_Data del proyecto
4. Abre el archivo AreasHelpPageApp_StartHelpPageConfig.cs y cancela los siguientes comentarios de código
Ejecuta el proyecto, abre la http://localhost:3619/Help y puedes ver el documento API generado automáticamente, que es una imagen del artículo
Descarga del proyecto:
Publicado en 6/10/2016 15:08:16
|
|
|
|
