AldoGiovanniGiacomo.API
REST API we don't deserve but we need.
https://aldogiovannigiacomoapi.azurewebsites.net/swagger
Check the live version here (Swagger page):here.
Endpoints listEnglish Version
News
I've built a Slack Application (coded in Node.js) that uses these APIs. You can take a look at the repository here: AldoGiovanniGiacomoSlackApp.
What Is This?
This is a simple REST API whose purpose is to provide quotes and infos about Aldo, Giovanni e Giacomo (a popular comic trio in Italy).
How It's Made? ©
This API is an ASP.NET CORE 5.0 Web Application solution. Packages/Technologies involved are:
- Entity Framework Core
- NSwag (to generate Swagger UI and OpenAPI docs)
CI/CD (Continuous Integration/Continuous Delivery) are provided by Travis-CI; you can find build history here The live version is hosted on Microsoft Azure @ https://aldogiovannigiacomoapi.azurewebsites.net/swagger.
If you wish, you can also download a collection of Postman calls here
Setup Locally
Setting up the project locally is pretty simple: just clone the repository and in the Package Manager Console run Update-Database
in order to create and seed the local database.
In case something goes wrong during this task, just update the connection string inside appsettings.Development.json with your own local connection string.
What's Next?
This project has been created just for fun but I'd like to give it a serious facade. Here's what I planned next:
- Upload a testing project for this API; ✅
- Give suppurt not only for single quotes but for dialogues too. ✅
- A page to allow user to submit their favourite Aldo, Giovanni e Giacomo quotes (after approvation).
Maybe create bots/extensions for client like Slack, Skype, etc...
Any Fork/Pull request/Suggestion/Comment/Help are welcome!! 😃
Italian Version
News
Ho creato una applicazione Node.js per Slack che usa queste API. Potete dare un'occhiata al repository qui: AldoGiovanniGiacomoSlackApp.
Che cos'è?
Semplici REST API con lo scopo di fornire citazioni ed informazioni su Aldo, Giovanni e Giacomo.
Com'è fatto?
Queste API sono create in una soluzione ASP.NET CORE 5.0 Web Application. Altre tecnologie/pacchetti coinvolti durante la creazione sono:
- Entity Framework Core
- NSwag (per generare la documentazione OpenAPI e l'interfaccia grafica di Swagger)
CI/CD (Continuous Integration/Continuous Delivery) sono forniti da Travis-CI; potete trovare la build history qui La live version è hostata su Microsoft Azure @ https://aldogiovannigiacomoapi.azurewebsites.net/swagger.
Se volete, potete scaricare anche una collezione di chiamate in Postman qui
Setup Locale
Settare il progetto in locale per procedere allo sviluppo è piuttosto semplice: basta clonare questo repository e nella Package Manager Console lanciare il comando Update-Database
per creare e popolare il database in locale.
Qualora qualcosa dovesse andare storto durante questo processo, cambiare la stringa di connessione presente nel file appsettings.Development.json con la propria stringa di connessione locale.
In futuro?
Questo progetto è nato per divertimento (chi non vorrebbe un generatore costante di citazioni di Aldo, Giovanni e Giacomo ?!) tuttavia vorrei che venisse sviluppato in maniera "seria". A seguire quello che ho pianificato per il futuro:
- Caricamento di un progetto di test per queste API; ✅
- Supportare non solo citazioni di frasi singole ma anche di dialoghi. ✅
- Creazione di una pagina per permettere agli utenti l'inserimento (previa approvazione) di altre citazioni di Aldo, Giovanni e Giacomo.
Forse creare chatbot/estensioni per client come Slack, Skype, ecc...