https://github.com/hirre/api-in-a-box

API in a Box is a generic API back-end service ready to scale web development.
https://github.com/hirre/api-in-a-box

api api-rest asp-net-core authorization database dotnet dotnetcore logging net server service software tls token-based-authentication webapi

Last synced: 27 days ago
JSON representation

API in a Box is a generic API back-end service ready to scale web development.

• Host: GitHub
• URL: https://github.com/hirre/api-in-a-box
• Owner: hirre
• License: apache-2.0
• Created: 2020-12-19T16:53:22.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-19T08:50:29.000Z (11 months ago)
• Last Synced: 2024-11-10T22:24:39.916Z (3 months ago)
• Topics: api, api-rest, asp-net-core, authorization, database, dotnet, dotnetcore, logging, net, server, service, software, tls, token-based-authentication, webapi
• Language: C#
• Homepage:
• Size: 187 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# API in a Box

The goal of this project is to have a "ready to go" API back-end service with all necessary features in order to scale web development. 

Features include:

- Token generation and validation 

- Authentication and authorization

- ReCaptcha support

- ORM EF Core + PostgreSql backend along with concurrency handling

- API key registration

- User registration and mail activation support

- NodaTime support

- HTTPS (TLS)

- Logging (file and console) with Serilog

- Works well with [Web App in a Box](https://github.com/hirre/webapp-in-a-box)

- and more...

## Create a self signed certificate

1) Install [OpenSSL](https://www.openssl.org)

2) Run and enter a key/certificate password along with other credentials:

```

openssl req -x509 -newkey rsa:4096 -keyout privateKey.pem -out certificate.pem -days 10000

openssl pkcs12 -export -out ServerCertificate.pfx -inkey privateKey.pem -in certificate.pem

```

Put "ServerCertificate.pfx" ("https_certificate" field in "src/ApiService/appsettings.json") in the "src/ApiService/" folder (it will automatically be copied to the binary output folder). Set the "https_certificate_password" field to your password and change the token key to something unique and hard to guess.

## PostgreSql

Download and install PostgreSql: https://www.postgresql.org/download/

Change the connection string in "src/ApiService/appsettings.json" to your setup.

## Reverse proxy

It is recommended to have Kestrel running behind a reverse proxy, e.g. Nginx.

Guide: https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel?view=aspnetcore-5.0#when-to-use-kestrel-with-a-reverse-proxy

## More info

https://docs.microsoft.com/en-us/aspnet/core/?view=aspnetcore-5.0