Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aaronshaf/confident
Use an OpenAPI (Swagger) design to define express routes, API documentation, and request/response validation
https://github.com/aaronshaf/confident
documentation openapi swagger validation
Last synced: 3 months ago
JSON representation
Use an OpenAPI (Swagger) design to define express routes, API documentation, and request/response validation
- Host: GitHub
- URL: https://github.com/aaronshaf/confident
- Owner: aaronshaf
- License: mit
- Created: 2016-09-21T17:59:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-14T16:19:13.000Z (over 7 years ago)
- Last Synced: 2024-09-30T15:12:58.381Z (3 months ago)
- Topics: documentation, openapi, swagger, validation
- Language: JavaScript
- Homepage:
- Size: 104 KB
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Confident treats your API specification (a .json file) as the source of truth for express routes, API documentation, and request/response validation. It's your swagger wagon.
## Features
* Works with existing Express app.
* Everything is opt-in. Incrementally integrate or eject.
* Validate your API schema.
* Validate requests.
* Validate responses.
* Serves up API documentation.
* Serves up /api.json.
* Suggests schemas to increase coverage.
* Supports basePath.
## Get started
```
npm install confident --save
```
### api.json
```json
{
"swagger": "2.0",
"info": {
"title": "Hello World",
"version": "1.0.0"
},
"paths": {
"/hello": {
"get": {
"summary": "Say hello to the world",
"operationId": "greet",
"responses": {
"200": {
"description": "Sweet success"
}
}
}
}
}
}
```
### index.js
```javascript
const confident = require('confident')
const express = require('express')
const app = express()
function greet (req, res) {
res.json('Hello, world.')
}
app.use(confident({
specification: './api.json',
docsEndpoint: '/docs',
operations: { greet }
}))
app.listen(3000)
```
## Generated documentation
`http://localhost:3000/docs`
## Tutorial video
* [Starting from scratch (4m53s)](https://cl.ly/0w1S0Q1O3o3z)
## See also
* [swagger-express-middleware](https://github.com/BigstickCarpet/swagger-express-middleware)
* [swaggerize-express](https://github.com/krakenjs/swaggerize-express)
* [swaggerize-routes](https://github.com/krakenjs/swaggerize-routes)
* [swagger-tools](https://github.com/apigee-127/swagger-tools)
* [swagger-node-express](https://github.com/swagger-api/swagger-node)
* [blueoak-server](https://github.com/BlueOakJS/blueoak-server)