Skip to content
/ api-server-starter Public template

api-server-starter is a foundational template for building API servers quickly and efficiently. It provides a minimal.

License

Notifications You must be signed in to change notification settings

keix/api-server-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Minimal API Server.

This can be used as a template for new projects, but the configuration is minimal.

Program behavior.

  • Nginx is listening on localhost:80
  • Forwards requests to Uvicorn, which is listening on localhost:8080
  • This application utilizes SQLite as its database system

Installation guide.

The installation guide outlines steps to clone the project, build it using Docker, and start the application.

 $ git clone [email protected]:keix/api-server-starter.git
 $ cd api-server-starter
 $ docker compose up --build

Usage.

To create a user, use this command:

 $ curl -X POST http://localhost/users/ -H "Content-Type: application/json" \
                        -d '{"email": "[email protected]", "password": "HelloWorld"}'

To retrieve the list of users, use this command:

 $ curl http://localhost/users/

API Specification.

FastAPI automatically generates API documentation upon running.

http://localhost/redoc

License

Under the terms of the MIT License. Copyright (c) 2024 Kei Sawamura (a.k.a keix)

About

api-server-starter is a foundational template for building API servers quickly and efficiently. It provides a minimal.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published