This project provides a public API for the SOLI (Standard for Open Legal Information) ontology.
If you just want to access the API, you don't need to run this project yourself. The API is freely available to the public,
including open CORS *
origins, at https://soli.openlegalstandard.org/.
For example, you can view the Lessor
class:
The SOLI API allows users to interact with the SOLI ontology, providing endpoints for searching, retrieving class information, and exploring the taxonomy.
The Swagger UI documentation can be found at https://soli.openlegalstandard.org/docs.
The OpenAPI spec file can be found at https://soli.openlegalstandard.org/openapi.json.
To run the SOLI API locally using Docker and Caddy, follow these steps:
-
Clone the repository:
git clone https://github.com/your-repo/soli-api.git cd soli-api
-
Build the Docker image:
docker build -t soli-api-ubuntu2404 -f docker/Dockerfile .
-
Check your configuration
View the config.json
file to ensure that the configuration is correct for your environment.
- Run the Docker container:
docker run -v $(pwd)/config.json:/app/config.json --publish 8000:8000 soli-api-ubuntu2404:latest
If you've changed the port in the config.json
file, make sure to update the port in the --publish
flag as well.
- Reverse proxy with Caddy (optional)
- Ensure you have Caddy installed on your system.
- Create a
Caddyfile
in the project root with the following content:<your.domain>> { encode gzip reverse_proxy localhost:8000 }
- Start Caddy:
caddy run
Now you can access the API at your.domain
(make sure to add this to your hosts file if testing locally).
Once the API is running, you can access the Swagger UI documentation at https://soli.openlegalstandard.org/docs
.
The API can be configured using the config.json
file. Modify this file to change settings such as the SOLI source, API metadata, and binding options.
Contributions are welcome! Please feel free to submit a Pull Request.
The SOLI Python library is released under the MIT License. See the LICENSE file for details.
If you encounter any issues or have questions about using the SOLI API, please open an issue on GitHub.
To learn more about SOLI, its development, and how you can get involved, visit the SOLI website or join the SOLI community forum.