ulisesgascon/simple-api repository overview

⁠ @ulisesgascon/simple-api

A very simple HTTP API to build fast prototypes

⁠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/todos List all TODOS
• POST /v1/todos 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

⁠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