@ulisesgascon/simple-api v4.0.1

About

A very simple HTTP API to build fast prototypes

❤️ Awesome Features:

• Typical Sample API with all the expected things (cors, fast response, immutability, etc..) 🚩
• Basic JSON storage without external dependencies or third party solutions 🔥
• Great testing coverage 🧪
• Easy to customize ⚙️
• Great Documentation with Swagger 📚
• Available as Npx, module, docker image and more... with a single command 📦

Available Routes

Important:

• By running npm run sample:generate you will regenerate a new TODOs dataset
• The server allows CRUD Operations but this operations are not affecting the dataset at all

Endpoints:

• GET /__/health check health
• GET /__/docs Swagger documentation for all the available endpoints
• GET /v1/todo List all TODOS
• POST /v1/todo Create a TODO
• GET /v1/todo/{id} Get a specific TODO
• PUT /v1/todo/{id} Update a specific TODO
• PATCH /v1/todo/{id} PAtch a specific TODO property
• DELETE /v1/todo/{id} Delete a specific TODO

PRO TIP Run simple-api and check the Swagger docs with payload details and great UI 🍿

Usage

Command line 🪄

Using Node.js's npx to start a simple api in local:

npx @ulisesgascon/simple-api

You can specify the port:

npx @ulisesgascon/simple-api 3000

Module 📦

Using @ulisesgascon/simple-api in your project:

const appInitialization = require('@UlisesGascon/simple-api')

;(async () => {
  const app = await appInitialization()

  app.listen(3000, () => console.log(`Server listening on port 3000!`))
})()

You can use app to extend the routes as it is the Typical express application

PRO TIP By default Swagger validator will be disabled as adding new routes can be complicated, but you can enable it:

const appInitialization = require('@UlisesGascon/simple-api')

;(async () => {
  const app = await appInitialization({
    swaggerEnabled: true
  })

  app.listen(3000, () => console.log(`Server listening on port 3000!`))
})()

Docker Version 🐳

Use Docker Hub:

# Pull the image from Docker Hub:
docker pull ulisesgascon/simple-api:latest

# Run container:
docker run -p 3000:3000 ulisesgascon/simple-api:latest

To build and run the container locally:

# Clone Repo:
git clone https://github.com/ulisesgascon/simple-api.git

# Change to repo's cloned directory:
cd simple-api

# Build Image locally:
docker build --no-cache -t ulisesgascon/simple-api:latest .

# Run container:
docker run -p 3000:3000  ulisesgascon/simple-api:latest

Development 🚀

Clone

git clone https://github.com/UlisesGascon/simple-api.git
cd simple-api

Install

nvm use
npm i

Start

# Regular
npm run start

# prettier logs:
npm run dev

Test

npm run test:coverage

Linting

npm run lint
npm run lint:fix

Formatting

npm run format
npm run format:fix

Contributing

Please consult CONTRIBUTING for guidelines on contributing to this project.

Author

@ulisesgascon/simple-api © Ulises Gascón, Released under the MIT License.