v1.0.0

Release notes

Yeoman generator to create a base structure for APIs based on Express framework and sequelize, using tools such as: eslint, prettier, swagger and others.

Features added in version 1.0.0:

• generator-express-api-generator only include configurations for development environment.
• Adds configurations for commitlint, prettier, swagger, husky, openapi, sequelize, jsonwebtoken and other tools.
• Installs database drivers and create Docker Compose configuration for postgresql, mysql and mariadb.
• Adds docker support.
• Adds docker compose support.
• Include dotenv and openapi-comment-parser in dev dependencies.
• Include ajv, ajv-errors and ajv-formats to use JSON Schemas.
• Include globs and jsonwebtoken in dependencies.
• If you do not want to use openapi.
  • Delete the api/src/schemas/openapi folder.
  • Delete the api/src/config/openapi.js file.
  • Delete the api/src/routes/swagger folder.
  • In the api/src/routes/index.js file, delete:

    if (environment !== 'production') {
      router.use('/docs', swaggerRouter)
    }

  • In terminal use:

      cd api
      npm uninstall openapi-comment-parser swagger-ui-express

  • delete api-specification.yml
  • Remove the openapi comment in the files in api/src/routes, for example:

      /**
        * GET /api/v1/users/{userEmail}
        *
        * @tag API endpoints
        * @security BearerAuth
        * @summary Get an user by email
        * @pathParam {string} userEmail
        * @response 200 - Ok
        * @responseContent {User} 200.application/json
        * @response 401 - Unauthorized
        * @responseComponent {Unauthorized} 401
        * @response 404 - Not found
        * @responseComponent {NotFound} 404
        * @response 500 - Internal Server Error
        * @responseComponent {InternalServerError} 500
      */
      router.get('/:userEmail', async (req, res) => {

    This comment begin with GET, POST, PUT or others HTTP Verb.
• If you do not want to use JSON Schemas.
  • Delete the api/src/schemas/json folder.
  • In terminal use:

      cd api
      npm uninstall ajv ajv-errors ajv-formats globs

  • Delete in files api/src/routes/user/registerRouter.js, api/src/routes/user/router.js and api/src/routes/authentication/tokenRouter.js

    import { simpleJsonSchemaValidation } from '../../schemas/json/index.js'