npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

olee-redoc-api-doc

v1.0.7

Published

`olee-express-api-doc` is a simple and configurable library for setting up automatic API documentation in Express.js applications using Swagger and Redoc. This library allows developers to easily generate and serve both Swagger UI and Redoc documentation

Downloads

59

Readme

olee-redoc-api-doc

olee-redoc-api-doc is a library for setting up automatic API documentation in Express.js applications using Swagger and Redoc.

Installation

npm install olee-redoc-api-doc

Basic Usage

const express = require('express');
const setupDocs = require('olee-redoc-api-doc');
require('dotenv').config();

const app = express();

setupDocs(app);

app.get('/users', (req, res) => {
  res.json([{ id: 1, name: 'John Doe' }]);
});

app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000');
});

Example Routes

/**
 * @swagger
 * /users:
 *   get:
 *     summary: Retrieve a list of users
 *     responses:
 *       200:
 *         description: A list of users
 *         content:
 *           application/json:
 *             schema:
 *               type: array
 *               items:
 *                 type: object
 */
app.get('/users', (req, res) => {
    res.json([{ id: 1, name: 'John Doe' }]);
  });

Advance Configuration

  const express = require('express');
const setupDocs = require('olee-redoc-api-doc'); // Adjust to your library's name

const app = express();

// Set up API documentation with advanced configuration
setupDocs(app, {
  title: 'Advanced API Documentation',
  version: '2.0.0',
  description: 'Detailed API documentation with advanced configuration',
  serverUrl: 'http://localhost:3000',
  apis: ['./src/routes/*.js'], // Adjust to your actual route file location
  swaggerDocsPath: '/docs', // Path to access Swagger UI
  redocPath: '/redoc', // Path to access Redoc
});

// Start the server
app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000');
});