Nonchalantly Performs Magic

    fastify-print-routes
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.3 • Public • Published

    fastify-print-routes

    Version Dependencies Build Coverage

    A simple plugin for Fastify prints all available routes.

    http://sw.cowtech.it/fastify-print-routes

    Installation

    Just run:

    npm install fastify-print-routes --save

    Usage

    Register as a plugin as early as possible, optional providing any of the following options:

    • useColors: If to use colors to highlight routes.

    Routes can be omitted by the list by setting hide option to true inside their config.

    Once the server is started, it will print on the console all available routes and methods.

    Example

    import fastify from 'fastify'
    import fastifyPrintRoutes from 'fastify-print-routes'
    
    const server = fastify()
    
    server.register(fastifyPrintRoutes)
    
    server.get('/path1', {
      async handler() {
        return { ok: true }
      }
    })
    
    server.route({
      url: '/path2/:params',
      method: ['POST', 'GET'],
      async handler() {
        return { ok: true }
      },
      config: {
        description: 'Title'
      }
    })
    
    server.route({
      url: '/path3',
      method: ['POST', 'GET'],
      async handler() {
        return { ok: true }
      },
      config: {
        hide: true
      }
    })
    
    server.listen(0, () => {
      console.log(`Server listening on port ${server.server.address().port} ...`)
    })

    Once started, this will be printed to the console:

    Available routes:
    
    ╔════════════╤════════════════╤═════════════╗
    ║  Method(s) │ Path           │ Description ║
    ╟────────────┼────────────────┼─────────────╢
    ║        GET │ /path1         │             ║
    ║ GET | POST │ /path2/:params │ Title       ║
    ╚════════════╧════════════════╧═════════════╝
    
    Server listening on port 60792 ...
    

    ESM Only

    This package only supports to be directly imported in a ESM context.

    For informations on how to use it in a CommonJS context, please check this page.

    Contributing to fastify-print-routes

    • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
    • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
    • Fork the project.
    • Start a feature/bugfix branch.
    • Commit and push until you are happy with your contribution.
    • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.

    Copyright

    Copyright (C) 2020 and above Shogun (shogun@cowtech.it).

    Licensed under the ISC license, which can be found at https://choosealicense.com/licenses/isc.

    Install

    npm i fastify-print-routes

    DownloadsWeekly Downloads

    739

    Version

    1.0.3

    License

    ISC

    Unpacked Size

    9.71 kB

    Total Files

    6

    Last publish

    Collaborators

    • shogun_panda