This repository contains an extension to APISuite Core that provides a backend for the marketplace feature.
There are 2 components in this extension that should be executed separately (for isolation/scaling purposes)
Starts with npm run server.
Serves a REST API, documented in openapi.yml.
Starts with npm run consumer.
Consumes application related events from APISuite's message broker.
Marketplace interactions need some information about the applications in APISuite. Therefore, this component keeps the database in sync with the core when it comes to some applications' data.
Docker images are available in our DockerHub.
Every new image is tagged with:
- latest (meaning this tag always points to the most recent released version)
- semantic version from
package.json
Depending on your goals, you could use a fixed version like 1.0.0 or
latest to simply get the most recent version every time you pull the image.
Configuration is done through environment variables.
All variables are declared and documented in src/config/schema.js.
Usually, at a minimum, these are the variables that need to be configured.
This ensures connectivity to the core's API and RabbitMQ instance, as well as proper CORS configuration to accept requests from the desired origin.
APISUITE_API_URL=http://apisuite-core-api:6001
CORS_ALLOW_ORIGIN=https://my.dev.portal.com
DB_URI=postgres://db_user:p4ssw0rd@dbserver:5432/marketplace_db
MSG_BROKER_URL=amqp://apisuite:RW8zBFj2b3KAAwWr2xgu@apisuite-msg-broker:5672
RABBITMQ_EVENTS_EXCHANGE=apisuite_events_dev
RABBITMQ_QUEUE=marketplace-apps-queue
Thi API server provides two monitoring endpoints:
GET /healthfor general health checking (of the server and major dependencies such as database connection)GET /metricsprovides Prometheus ready metrics concerning requests time and status codes
- Commits should follow conventional commits spec
package.jsoncontains the necessary scripts and dependencies to run the components of this project- Typescript is configured to produce source maps, which makes debugger usage possible
- API driven development is preferred, so that we can keep the API solid and consistent
- Database migrations should be planed/created in a gradual way to avoid breaking changes (example: renaming a column can be done in 2 steps: create new column; change code to start using new column; delete old column when code no longer references it)
Knex.js CLI is used for migration management: http://knexjs.org/#Migrations
Generate a migration: npx knex migrate:make --migrations-directory ./migrations create-table