Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cailloumajor/config-api
Configuration data HTTP API
https://github.com/cailloumajor/config-api
json-api microservice mongodb rust toml
Last synced: 14 days ago
JSON representation
Configuration data HTTP API
- Host: GitHub
- URL: https://github.com/cailloumajor/config-api
- Owner: cailloumajor
- License: mit
- Created: 2022-05-24T08:48:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-08T13:28:39.000Z (16 days ago)
- Last Synced: 2025-01-08T14:45:04.327Z (16 days ago)
- Topics: json-api, microservice, mongodb, rust, toml
- Language: Rust
- Homepage:
- Size: 763 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Configuration API microservice
[](https://conventionalcommits.org)
Microservice serving configuration data as an HTTP API backed by MongoDB.
## Routes
### Health
#### `GET` `/health`
Returns the service health status.
##### Parameters
None
##### Response
| Code | Description |
| ---- | -------------------- |
| 204 | Service is healthy |
| 500 | Service in unhealthy |
### Get configuration data (all documents in a collection)
#### `GET` `/config/{collection}`
Returns the configuration data for all the documents in the collection.
##### Parameters
| Name | Source | Description |
| ------------ | ------ | ------------------ |
| `collection` | _path_ | MongoDB collection |
##### Response
| Code | Description |
| ---- | --------------------------------------------- |
| 200 | JSON array of all documents in the collection |
| 500 | Internal server error |
###### Note: the array returned in case of success will be sorted by primary key
### Get configuration data (one document)
#### `GET` `/config/{collection}/{id}`
Returns configuration data for a specific document.
##### Parameters
| Name | Source | Description |
| ------------ | ------ | -------------------------- |
| `collection` | _path_ | MongoDB collection |
| `id` | _path_ | ID of the MongoDB document |
##### Response
| Code | Description |
| ---- | ----------------------- |
| 200 | Document in JSON format |
| 404 | Document not found |
| 500 | Internal server error |
##### Linked document
If the MongoDB document found contains a `_links` key with an [`ObjectId`][BSON ObjectId] value, the returned document will be the one with this index.
[BSON ObjectId]: https://www.mongodb.com/docs/v6.0/reference/bson-types/#objectid
### Patch configuration data
#### `PATCH` `/config/{collection}/{id}`
Applies changes on a configuration document.
##### Parameters
| Name | Source | Description |
| ------------ | ------ | -------------------------- |
| `collection` | _path_ | MongoDB collection |
| `id` | _path_ | ID of the MongoDB document |
##### Request body
The expected body request is a JSON object with key(s) and value(s) corresponding with those of the database document.
##### Authorization
The changes will be applied if all the following conditions are met:
* a document with `_authorization` primary key exists;
* this document contains a `patchAllowedFields` field;
* this field is an array;
* this array contains all of the keys of the request JSON body (as strings).
## Usage
```ShellSession
$ config-api --help
Usage: config-api [OPTIONS] --mongodb-database
Options:
--listen-address
Address to listen on [env: LISTEN_ADDRESS=] [default: 0.0.0.0:8080]
--mongodb-uri
URI of MongoDB server [env: MONGODB_URI=] [default: mongodb://mongodb]
--mongodb-database
MongoDB database [env: MONGODB_DATABASE=]
-v, --verbose...
Increase logging verbosity
-q, --quiet...
Decrease logging verbosity
-h, --help
Print help
```