Nightly Panic Munchies

    joi-openapi-generator
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.1 • Public • Published

    OpenAPI generator

    This is a tool for generating OpenAPI schemas from koa-joi-router definitions. It is compatible with joi 17.x.x.

    Usage

    You can create koa-joi-router as usual and provide some metadata in route definitions.

    Router meta options:

    • name: string - name of the route (will be used as operationId)
    • group?: string
    • version
    • tags
      • assigned tags to the route can be matched during the build
      • tags with prefix openapi- will be included in tags property in the operation object
      • reserved tags: ignore-route

    Moreover you can provide some meta options in Joi validation schemas.

    Joi meta options:

    • name: string - when set the type will be extracted and exported with this name
    • deprecated: boolean

    Generator also supports many Joi native features, such as examples, description, key presence or various flags.

    Keywords

    none

    Install

    npm i joi-openapi-generator

    DownloadsWeekly Downloads

    51

    Version

    1.2.1

    License

    ISC

    Unpacked Size

    272 kB

    Total Files

    33

    Last publish

    Collaborators

    • janzal