Antes, durante e incluso después de la implementación de los servicios web, una guía de usuario actualizada es muy importante para nuestros clientes. Estoy tratando de encontrar una herramienta API para Restful Web Services que pueda producir un documento / guía de usuario fácil de usar en formato WORD o PDF. ¿Hay alguna sugerencia?
Los puntos clave incluyen:
¿Has probado apidocjs ?
API de documentación
Bueno, es bastante fácil, porque lo que tenemos que hacer es simplemente comentar nuestro código. Esto es un ejemplo.
/** * @api {get} /user/:id Request User information * @apiName GetUser * @apiGroup User * * @apiParam {Number} id Users unique ID. * * @apiSuccess {String} firstname Firstname of the User. * @apiSuccess {String} lastname Lastname of the User. */
Ejemplo en Lumen Framework , puede poner el comentario en Controladores app/Http/Controllers/UserController@create. @consulte la función dentro del controlador.
Use este comando para generar el documento
apidoc -i app/Http/Controllers -o public/docs
Información básica sobre API (guía de usuario actual)
Sí, vaya al ejemplo de apidocjs .
Cómo usar las API
Véase el ejemplo anterior.
Pruebe las API antes de la implementación
Tiene una característica interesante, consulte @apiSampleRequest. Pero si quiere decir que Test es Unit Testing o Functional Testing, apidocjs no es compatible.
miguel freidgeim