https://github.com/tasmidur/openapi-doc-generator
Open API Generator is a CLI tool that generates OpenAPI documentation based on database table schema. It also provides an endpoint for viewing the OpenAPI documentation in both Swagger UI and JSON formats.
https://github.com/tasmidur/openapi-doc-generator
Last synced: 2 months ago
JSON representation
Open API Generator is a CLI tool that generates OpenAPI documentation based on database table schema. It also provides an endpoint for viewing the OpenAPI documentation in both Swagger UI and JSON formats.
- Host: GitHub
- URL: https://github.com/tasmidur/openapi-doc-generator
- Owner: tasmidur
- License: mit
- Created: 2024-02-12T10:24:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-18T10:07:18.000Z (about 1 year ago)
- Last Synced: 2025-01-26T11:29:32.156Z (4 months ago)
- Language: TypeScript
- Size: 613 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# OpenAPI Document Generator
[](https://www.npmjs.com/package/openapi-doc-generator)
[](https://www.npmjs.com/package/openapi-doc-generator)
[](https://opensource.org/licenses/MIT)
OpenAPI Doc Generator is a CLI tool that generates OpenAPI documentation based on database table schema. It also provides an endpoint for viewing the OpenAPI documentation in both Swagger UI and JSON formats.
## Installation
Installing openapi-doc-generator globally to access `oasc` CLI
```bash
npm install openapi-doc-generator -g
yarn add global openapi-doc-generator
```
Then run `oasc init` for initialization of `schema.config.js` file then modify as your requirement.
```bash
oasc init
```
Modify the `schema.config.js`
```javascript
require("dotenv").config();
const schemaConfig = {
defaultDatabase: 'sqlite',
databases: {
postgres: {
host: 'localhost',
port: 5432,
user: 'postgres',
password: '123456',
database: 'testing'
},
mysql: {
host: 'localhost',
port: 3306,
user: 'root',
password: '123456',
database: 'schema_builder'
},
sqlite: { database: './schema_builder.db' }
},
skipColumns: [ 'created_at', 'updated_at', 'deleted_at' ],
validationSchemaType: 'joi'
};
module.exports = schemaConfig;
```
## Usage
The `oasc joi -t my_table -db mysql -c column1,column2` command generates validation rules for a specified database table and its columns. It creates a validation rules based on the chosen validation libraries like `joi`, "validatorjs", "vine". The generated rules can be used to enforce data integrity and validate incoming requests in your application.
Options:
- -db, --database: Specify the type of database (e.g., `mysql`, `postgres`, `sqlite`).
- -t, --table: Specify the name of the database table for which rules should be generated.
- -c, --columns: Specify the column names of the table to generate rules for.
- -h, --help: Display help for the command.
Examples:
- Generate rules for a MySQL table named `users` with columns `id` and `name`:
```bash
oasc joi -t users -db mysql -c id,name
```
- Generate rules for a PostgreSQL table named `users` with a validation library `validatorJs`:
```bash
oasc validatorJs -t users -db mysql -c id,name
```
as same as for sqlite.
Let's say you've the table structure:
```sql
CREATE TABLE data_types (
id INTEGER PRIMARY KEY,
name TEXT,
age INTEGER,
height REAL,
is_student BOOLEAN,
birthdate DATE,
registration_timestamp TIMESTAMP,
description BLOB
created_at TIMESTAMP,
updated_at TIMESTAMP
);
```
### Generate rules for a whole table
Now if you run:
```bash
oasc joi -db sqlite -t data_types
```
You'll get:
```
🚀 Schema Base Validation rules for "joi" generated! 🚀
Copy and paste these rules into your validation location, such as controller, form request, or any applicable place 😊
______________________________________________________________________________________________________________________
{
name: Joi.string().required(),
age: Joi.integer().min(-9223372036854775808).max(9223372036854775807).required(),
height: Joi.number().required(),
is_student: Joi.required(),
birthdate: Joi.date().required(),
registration_timestamp: Joi.required(),
description: Joi.required(),
}
```
### Generate rules for specific columns
You can also explicitly specify the columns:
```bash
oasc joi -db sqlite -t data_types -c name,age
```
Which gives you:
```
🚀 Schema Base Validation rules for "joi" generated! 🚀
Copy and paste these rules into your validation location, such as controller, form request, or any applicable place 😊
______________________________________________________________________________________________________________________
{
name: Joi.string().required(),
age: Joi.integer().min(-9223372036854775808).max(9223372036854775807).required(),
}
```
### Always skip columns
To always skip columns add it in the `schema-config.js` file, under `skipColumns` attribute.
```javascript
skipColumns: (process.env.SKIP_COLUMNS || 'created_at,updated_at,deleted_at').split(',')
```
## Supported Drivers
Supported database drivers are MySQL, PostgreSQL, and SQLite.
Validation rules may vary based on the selected driver due to differences in supported data types and range specifications.
## Testing
```bash
yarn test
```
## Author
👤 **Md Tasmidur Rahman (https://tasmidur.netlify.app)**
* Linkedin: [@tasmidur](https://www.linkedin.com/in/tasmidur/)
* Github: [@tasmidur](https://github.com/tasmidur)
* Medium: [@tasmidur](https://medium.com/@tasmidur)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/tasmidur/nodejs-dynamic-validation-rules/issues)
## Show your support
Give a ⭐️ if this project helped you!
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.