README.md 7.03 KB
Newer Older
Alex Quispe's avatar
Alex Quispe committed
1
2
# Apidoc Generator

Alex Quispe's avatar
Alex Quispe committed
3
Genera la documentación de un servicio web RESTFull con soporte para ApidocJS y Swagger
Alex Quispe's avatar
Alex Quispe committed
4
5
6
7
8

La documentación se genera a partir de las respuestas que devuelve el servicio.

## Requisitos:

Alex Quispe's avatar
Alex Quispe committed
9
10
- Es posible documentar las rutas a partir de una instancia de `express`, sin necesidad de levantar el servicio.
- Si el servicio está activo en modo `development` o `test`, es posible ejecutar funciones adicionales realizando peticiones sobre el servicio, permitiendo de esa forma documentar las respuestas automaticamente.
11

Alex Quispe's avatar
Alex Quispe committed
12
13
14
15
16
17
### Archivo `src/auth.js`

```js
const ApiGen = require('apidoc-generator')

module.exports = async () => {
18
19
  await ApiGen.post('/api/auth/signin').inputData({ body: { user: 'demo1', password: 'Developer' } }).generate()               // Sin verificar
  await ApiGen.post('/api/auth/signin').inputData({ body: { user: 'demo1', password: 'Developer' } }).request(true).generate() // Verifica la ruta
Alex Quispe's avatar
Alex Quispe committed
20
21
22
}
```

23
24
La propiedad `request(true)` indica si se va a ejecutar la petición, en tal caso se documenta el resultado de la petición automáticamente.

Alex Quispe's avatar
Alex Quispe committed
25
26
27
28
29
30
### Archivo `src/api.js`

```js
const ApiGen = require('apidoc-generator')

module.exports = async () => {
31
  const login = await ApiGen.post('/api/auth/signin').inputData({ body: { user: 'demo1', password: 'Developer' } }).execute()
Alex Quispe's avatar
Alex Quispe committed
32
33
34

  const AUTH_HEADER = { Authorization: `Bearer ${login.token}` }

35
  await ApiGen.get('/api/v1/instituciones').inputData({ headers: AUTH_HEADER }).request(true).generate('CUSTOM GROUP')
Alex Quispe's avatar
Alex Quispe committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
}
```

## Modo de uso

`node index.js`

El resultado se encuentra en la carpeta `build`

- Apidoc compilado: `build/apidoc`
- Json Swagger: `build/apidoc/swagger.json`

## Documentación

50
51
52
53
54
55
56
57
58
59
### Métodos soportados:

```js
await ApiGen.get('api/v1/users').generate()
await ApiGen.post('api/v1/users').generate()
await ApiGen.put('api/v1/users/:id').generate()
await ApiGen.patch('api/v1/users/:id').generate()
await ApiGen.delete('api/v1/users/:id').generate()
```

Alex Quispe's avatar
Alex Quispe committed
60
61
### Funciones disponibles:

62
63
64
65
66
67
68
69
70
71
72
73
74
| Función          | Descripción                                                            | Valor por defecto       |
| ---------------- | ---------------------------------------------------------------------- | ----------------------- |
| `name`           | Nombre con el que se identificará a la ruta.                           | `<method>/<path></key>` |
| `group`          | Grupo al que pertenece la ruta.                                        | `<fileName>`            |
| `description`    | Descripción de la ruta.                                                | `null`                  |
| `version`        | Versión.                                                               | `1`                     |
| `permissions`    | Lista de los roles. Ej.: `.permissions(['admin', 'user'])`             | `null`                  |
| `request`        | Indica si se va a ejecutar la petición para crear los datos de salida. | `false`                 |
| `key`            | Palabra clave que se adiciona al final del nombre de la ruta.          | `null`                  |
| `inputData`      | Datos de entrada: `{ headers: {}, params: {}, query: {}, body: {} }`   | `{}`                    |
| `outputData`     | Datos de salida: `body`                                                | `{}`                    |
| `inputExamples`  | Ejemplos de datos de entrada: `{ title: '', data: obj }`               | `null`                  |
| `outputExamples` | Ejemplos de datos de salida: `{ title: '', data: obj }`                | `null`                  |
Alex Quispe's avatar
Alex Quispe committed
75
76
77
78

**Ejemplo:**

```js
79
await ApiGen.get('/api/v1/users').generate()
80
81
await ApiGen.post('/api/v1/users').inputData({ body; { user: 'admin', pass: '123'} }).generate()
await ApiGen.post('/api/v1/users').inputData({ body; { user: 'admin', pass: '123'} }).name('Autenticar').generate()
82

83
84
await ApiGen.get('/api/v1/users').key('Admin').generate()
await ApiGen.get('/api/v1/users').key('User').generate()
85

86
await ApiGen.get('/ruta/verificada').request(true).generate()
Alex Quispe's avatar
Alex Quispe committed
87
88
89
90
91
92
93
94
95
96
97
98
99
```

### Función `execute`

Ejecuta la petición y devuelve el resultado del body.

```js
// Devuelve una lista de usuarios
const usuarios = await ApiGen.get('/api/v1/users').execute()
```

### Función `generate`

100
Ejecuta la petición (solamente si la propiedad `request` es igual a `true`), genera el respectivo apidoc y devuelve el resultado del body.
Alex Quispe's avatar
Alex Quispe committed
101
102
103
104
105
106
107

Adicionalmente se puede pasar como parámetro el nombre del grupo al que pertenece la ruta. Por defecto es el nombre del fichero.

```js
// group = <fileName>
await ApiGen.get('/api/v1/users').generate()

108
109
// group = Auth
await ApiGen.get('/api/v1/users').generate('Auth')
Alex Quispe's avatar
Alex Quispe committed
110

111
// Devuelve el resultado de la petición (body)
Alex Quispe's avatar
Alex Quispe committed
112
113
const body = await ApiGen.get('/api/v1/users').generate()
```
114

Alex Quispe's avatar
Alex Quispe committed
115
## Configuración del proyecto para generar la documentación
116
117


Alex Quispe's avatar
Alex Quispe committed
118
### Estructura
119

Alex Quispe's avatar
Alex Quispe committed
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
```txt
app
  ├─ documentation
  |    ├─ build
  |    ├─ src
  |    │    ├─ api.js
  |    │    └─ auth.js
  |    ├─ scaffold.js
  |    ├─ generate.js
  |    └─ server.js
  ├─ src
  │    └─ app.js
  ├─ index.js
  └─ package.json
```
135

Alex Quispe's avatar
Alex Quispe committed
136
137
### Archivo `documentation/scaffold.js`
Este fichero se encarga de crear los ficheros necesarios para documentar las rutas:
138

Alex Quispe's avatar
Alex Quispe committed
139
140
141
-  `documentation/src/api-v1-users.js`
-  `documentation/src/api-v1-users.json`
-  `documentation/src/api-v1-users.yml`
142

Alex Quispe's avatar
Alex Quispe committed
143
En este ejemplo, se dará prioridad al fichero `api-v1-users.js`, posteriormente al fichero `JSON` o `YAML` según se haya configurado en la variable `HELP_TYPE`.
144
145
146
147
148
149
150
151
152
153
154
155
156

```js
const ApiGen = require('apidoc-generator')
const path   = require('path')

ApiGen.SRC_PATH = path.resolve(__dirname, 'src')
ApiGen.HELP_TYPE = 'YAML' // YAML o JSON

const app = require('../src/app')

ApiGen.scaffold(app)
```

Alex Quispe's avatar
Alex Quispe committed
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
### Archivo `documentation/generate.js`
Este fichero se encarga de generar la documentación con soporte para ApidocJS y Swagger.

```js
const ApiGen = require('apidoc-generator')
const path   = require('path')

ApiGen.API_URL         = 'http://localhost:4000'
ApiGen.DOC_SERVER_PORT = 5000
ApiGen.BUILD_PATH      = path.resolve(__dirname, 'build')
ApiGen.SRC_PATH        = path.resolve(__dirname, 'src')
ApiGen.HELP_TYPE       = 'YAML'  // YAML o JSON
ApiGen.DESCRIPTION     = 'Descripción general del Apidoc'

ApiGen.create().catch(e => console.log(e))
```

### Archivo `documentation/server.js`
Este fichero, se encarga de ejecutar un servidor para visualizar la documentación.
176
177
178
179
180
181
182
183
184
185
186
187
188

```js
const ApiGen = require('apidoc-generator')
const path   = require('path')

ApiGen.DOC_SERVER_PORT = 5000
ApiGen.BUILD_PATH      = path.resolve(__dirname, 'build')

const SWAGGER_JSON_URL = `http://localhost:${ApiGen.DOC_SERVER_PORT}/swagger.json`
ApiGen.REDIRECT_PATH   = `/swagger?url=${SWAGGER_JSON_URL}`

ApiGen.server()
```
Alex Quispe's avatar
Alex Quispe committed
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206

### Archivo `package.json`

```json
{
  "name": "example",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "start": "node index",
    "doc:scaffold": "node documentation/scaffold",
    "doc:generate": "node documentation/generate",
    "doc:server": "node documentation/server",
    "doc:start": "npm run doc:scaffold && npm run doc:generate && npm run doc:server"
  }
}
```