Character API is a simple REST API to store and retrieve character documents.
I built this API mainly to investigate how to use Babel with Node and to explore the library Fluture. It is not meant to be used in a real environment, but rather as an exercise to build a minimally functional app using new concepts.
The setup for Babel includes the plugin for the pipeline operator proposal.
Character API has two end points, which accept requests in several methods:
/api/charactersGET: Returns a paginated list of all the characters stored in the database. It accepts an optional query parameterpage.POST: It creates a new document in the database. It returns 400 if the document isn't formatted correctly.
/api/characters/:idGET: Returns a specific document from the database matching theidprovided or 404 if no such id exists.PUT: Updates a specific document from the database matching theidprovided. It returns 404 if no such id exists or 400 if the document isn't formatted correctly.DELETE: Deletes a specific document from the database matching theidprovided. It returns 404 if no such document exists.
All documents submitted via POST and PUT requests must include the following fields (though they can include more):
name: astringspecifying the character's name.aliases: anarrayindicating the character's aliases if any. It can be empty.feats: anarrayindicating important achievements of the character. It can be empty.occupation: astringindicating the character's occupation.
To use this application you will need Node >= 12
Clone the project and install its dependencies:
git clone git@github.com:arturjzapater/character-api.git
cd character-api
npm iCreate a copy of the .env file:
cp -a .env.example .envSeed database:
npm run seedStart the server in development mode:
npm run devtest: run unit teststest:watch: run unit tests on watch modee2e: run end-to-end testsdev: run the server in development modebuild: build the files with babelstart: build and start the server in production modeseed: add some mock data to the database