auto-rest-api

Auto-REST

A command line tool for deploying dynamically generated REST APIs against relational databases. See the project documentation for detailed usage instructions.

Supported Databases

Auto-REST provides built-in support for the database types listed below. Support for additional databases can be added by installing the corresponding database drivers. See the official documentation for instructions.

Flag	Default Driver	Database Type
--sqlite	sqlite+aiosqlite	SQLite
--psql	postgresql+asyncpg	PostgreSQL
--mysql	mysql+asyncmy	MySQL
--oracle	oracle+oracledb	Oracle
--mssql	mssql+aiomysql	Microsoft SQL Server
--driver	Custom driver (user-defined)	Custom

Quickstart

Install the command line utility using your favorite Python package manager.

pipx install auto-rest-api

Check the package installed correctly.

auto-rest --help

Launch an API by providing connection arguments to a database of your choice.

auto-rest \
  # Enable optional endpoints / functionality
  --enable-docs \
  --enable-write \
  # Define the database type and connection arguments
  --psql 
  --db-host localhost
  --db-port 5432
  --db-name default
  --db-user jsmith
  --db-password secure123!

Navigate localhost:8081/docs/ to view the OpenAPI documentation for your dynamically generated REST API!