exsersewo
/
RestAPI
1
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity
Turn any database into a GET-able Rest API
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10 Commits
1 Branch
2 Tags
55 KiB
 
 
Tag: Branch: Tree: cbd529613c
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'cbd529613c'
${ noResults }
exsersewo cbd529613c
Create README.md 		5 years ago
.github Create README.md 5 years ago
src Update RestAPI.csproj 5 years ago
.dockerignore Add Docker 5 years ago
.env.default Add Docker 5 years ago
.gitignore Initial commit 5 years ago
NuGet.config Update NuGet.config 5 years ago
azure-pipelines.yml Update azure-pipelines.yml 5 years ago
docker-compose.yml Add Docker 5 years ago

.github/README.md

RestAPI

Build Status Codacy Badge

A Restful GET-only database agnostic API provider built with ASP.Net & .Net 5.0; Inspiration from: project-open-data/db-to-api

Supports

Output

HTML, JSon, XML

Databases

Currently Supported

MariaDB, MySql, MongoDB, PostgreSQL

In Development

Firebird, SQLite, IBM, Informix, MS SQL Server, ODBC/DB2, Oracle, CUBRID, 4D

Self Hosting

Prerequisites
  • Visual Studio >= 2019
  • .Net Version >= 5.0
  • (If Docker; Docker & Docker Compose)

Development Builds

  1. Clone the dev branch
  2. Open /src/RestAPI.sln within Visual Studio
  3. Build the solution
  4. Copy /.env.default into output/.env
  5. Follow the steps for Consumer Releases from Step 3. onwards

Consumer Releases (non Docker)

  1. Download the latest release
  2. Copy /.env.default into /.env
  3. Run RestAPI.exe or dotnet RestAPI.dll
  4. 🎊 You now have a working instance of RestAPI 🎊

Consumer Releases (with Docker)

  1. Download the latest release
  2. Copy .env.default into .env
  3. Configure the .env file
  4. Run docker-compose up
  5. 🎊 You now have a working instance of RestAPI 🎊