|
7 | 7 | [](https://fairdatapoint.readthedocs.io/en/latest/?badge=latest) |
8 | 8 | [](https://doi.org/10.5281/zenodo.19236251) |
9 | 9 |
|
10 | | -The [FAIR Data Point (FDP)] is an HTTP API for creating, storing, and serving FAIR metadata (**F**indable, **A**ccessible, **I**nteroperable, **R**eusable). |
| 10 | +The [FAIR Data Point (FDP)] provides an HTTP API for creating, storing, and serving FAIR (**F**indable, **A**ccessible, **I**nteroperable, **R**eusable) metadata in the form of [RDF]. |
11 | 11 | The metadata content is generated semi-automatically according to the [FAIR Data Point specification]. |
12 | 12 |
|
13 | 13 | ## Usage |
14 | 14 |
|
15 | | -More information about FDP, how to deploy it and use it can be found in the [FDP documentation]. |
| 15 | +More information about the FDP, how to deploy it, and how to use it, can be found in the [FDP documentation]. |
16 | 16 |
|
17 | 17 | ### API Documentation |
18 | 18 |
|
19 | | -The FAIR Data Point API comes with embedded [OpenAPI] documentation based on SwaggerUI. |
20 | | -Each FDP serves human friendly API documentation at the path `/swagger-ui.html`, for example, https://app.fairdatapoint.org/swagger-ui.html. |
21 | | -In addition, machine readable API docs are available at the path `/v3/api-docs`, for example, https://app.fairdatapoint.org/v3/api-docs. |
| 19 | +The FAIR Data Point API also comes with embedded [OpenAPI] documentation based on SwaggerUI. |
| 20 | +Each FDP serves its own human friendly API documentation at the path `/swagger-ui.html`, for example, https://app.fairdatapoint.org/swagger-ui.html. |
| 21 | +In addition, machine readable API docs (JSON) are available at the path `/v3/api-docs`, for example, https://app.fairdatapoint.org/v3/api-docs. |
22 | 22 |
|
23 | 23 | ## Development |
24 | 24 |
|
25 | 25 | ### Technology Stack |
26 | 26 |
|
| 27 | +The FDP was built on the following technology stack and is typically deployed as a Docker container. |
| 28 | + |
27 | 29 | - **Spring-boot** |
28 | 30 | - **Java** |
29 | 31 | - **Maven** |
30 | 32 | - **MongoDB** |
31 | | -- **Docker** (only required for building a Docker image) |
| 33 | +- **Docker** (only required for building a Docker image and running the container) |
32 | 34 |
|
33 | 35 | ### Build & Run |
34 | 36 |
|
@@ -128,3 +130,4 @@ This project is licensed under the MIT License - see the [LICENSE] file for more |
128 | 130 | [contribution guidelines]: CONTRIBUTING.md |
129 | 131 | [code of conduct]: CODE_OF_CONDUCT.md |
130 | 132 | [mongo docker image]: https://hub.docker.com/_/mongo/ |
| 133 | +[RDF]: https://www.w3.org/TR/rdf11-primer/ |
0 commit comments