github.com/shodske/payment-api
This is an example repo for a small RESTful API in which you can manage payments.
This API is based on the json:api specification and one can expect the API to behave according to this specification.
For ease of use a docker-compose.yml has been created that will run
the API, database and Swagger UI.
The API specification is written in OpenAPI Specification 3.0
and can found in api/oas.yml.
A Swagger UI docker image is set up for easier reading and sending requests to the API.
A docker-compose.yml file has been set up to start the API. Which can
be run using the Makefile. To override any of the environment
variables, you can create a .env file in the project root, which will
be picked up by docker-compose.
make start: Start the Docker containers running the API, the Postgres
database and Swagger UI.make stop: Stop all Docker containers.make logs: Follow the logs of the API and Postgres database.make test: Run all tests.FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.