README.md 8.51 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

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

7
## Caracteristicas:
Alex Quispe's avatar
Alex Quispe committed
8

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
- Es posible generar un escaffold para los tests.
12

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

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

module.exports = async () => {
19
20
  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
21
22
23
}
```

24
25
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
26
27
28
29
30
31
### Archivo `src/api.js`

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

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

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

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

## 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

51
52
53
54
55
56
57
58
59
60
### 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
61
62
### Funciones disponibles:

63
64
65
66
67
68
69
70
71
72
73
74
75
| 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
76
77
78
79

**Ejemplo:**

```js
80
await ApiGen.get('/api/v1/users').generate()
81
82
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()
83

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

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

### 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`

101
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
102
103
104
105
106
107
108

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()

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

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

116
## Configuración del proyecto para generar la documentación y los tests
117
118


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

Alex Quispe's avatar
Alex Quispe committed
121
122
123
124
```txt
app
  ├─ documentation
  |    ├─ build
125
126
127
  |    ├─ template
  |    │    ├─ test-block.js
  |    │    └─ test-body.js
Alex Quispe's avatar
Alex Quispe committed
128
  |    ├─ src
129
  |    │    └─ api-v1-users.js
Alex Quispe's avatar
Alex Quispe committed
130
  |    ├─ scaffold.js
131
  |    ├─ scaffold-test.js
Alex Quispe's avatar
Alex Quispe committed
132
133
134
135
  |    ├─ generate.js
  |    └─ server.js
  ├─ src
  │    └─ app.js
136
137
  ├─ test
  │    └─ api-v1-users.test.js
Alex Quispe's avatar
Alex Quispe committed
138
139
140
  ├─ index.js
  └─ package.json
```
141

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

Alex Quispe's avatar
Alex Quispe committed
145
146
147
-  `documentation/src/api-v1-users.js`
-  `documentation/src/api-v1-users.json`
-  `documentation/src/api-v1-users.yml`
148

Alex Quispe's avatar
Alex Quispe committed
149
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`.
150
151
152
153
154
155
156
157

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

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

Alex Quispe's avatar
Alex Quispe committed
158
const app = require(process,cwd())
159
160
161
162

ApiGen.scaffold(app)
```

163
164
165
166
167
168
169
170
171
172
173
### Archivo `documentation/scaffold-test.js`
Este fichero se encarga de crear los ficheros necesarios para testear los servicios.

Se requieren los paquetes: `ava` y `supertest` para ejecutar los tests.

-  `test/api-v1-users.test.js`

```js
const ApiGen = require('./../../')
const path   = require('path')

174
175
ApiGen.TEST_PATH     = path.resolve(__dirname, '../test')
ApiGen.TEMPLATE_PATH = path.resolve(__dirname, 'template')
176

177
const app = require(process.cwd())
178
179
180
181

ApiGen.scaffoldTest(app)
```

182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
### Templates para generar los tests

Templates por defecto: Se configuran con la variable `ApidocGenerate.TEMPLATE_PATH`

#### Archivo `template/test-block.js`
```js
test.serial.cb('[GROUP] [METHOD] PATH', t => {
  request(app).METHOD('PATH')
    .set('Accept', 'application/json')
    .expect('Content-Type', /json/)
    .end((err, res) => {
      t.pass()
      t.end()
    })
})

// <!-- [TEST DEFINITION] --!> //
```

#### Archivo `template/test-body.js`
```js
const test    = require('ava')
const request = require('supertest')

const app = require(process.cwd())

// <!-- [TEST DEFINITION] --!> //
```

Alex Quispe's avatar
Alex Quispe committed
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
### 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.
230
231
232
233
234
235
236
237
238
239
240
241
242

```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
243
244
245
246
247
248
249
250
251
252
253

### Archivo `package.json`

```json
{
  "name": "example",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "start": "node index",
254
    "test": "NODE_ENV=test ava test/* --serial --verbose",
Alex Quispe's avatar
Alex Quispe committed
255
    "doc:scaffold": "node documentation/scaffold",
256
    "doc:scaffold:test": "node documentation/scaffold-test",
Alex Quispe's avatar
Alex Quispe committed
257
258
259
    "doc:generate": "node documentation/generate",
    "doc:server": "node documentation/server",
    "doc:start": "npm run doc:scaffold && npm run doc:generate && npm run doc:server"
260
261
262
263
  },
  "dependencies": {
    "ava": "^0.25.0",
    "supertest": "^3.3.0"
Alex Quispe's avatar
Alex Quispe committed
264
265
266
  }
}
```