Skip to content

Instantly share code, notes, and snippets.

@matthieubosquet
Created March 17, 2019 18:09
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save matthieubosquet/90225f5f0905d4bbc9ee745eca85abbf to your computer and use it in GitHub Desktop.
Save matthieubosquet/90225f5f0905d4bbc9ee745eca85abbf to your computer and use it in GitHub Desktop.
Description of API services required for a good open linked data service
Base URLs
- for resources: https://id.example.com/
- for ontology: https://id.example.com/schema/
- for API: https://api.example.com/
API
1. Root files
/humans.txt
/robots.txt
/favicon.ico
/openapi.json
/index.html (documentation)
2. Services
/id: Dereference a resource by resource url and generate id (Get resource; Get -> returns random Id)
/odata: Provides a standard OData endpoint over data
/photo: Image processing (Get with multiple URL parameters)
/query: Provides parameterized queries (facilitates caching)
/s: URL shortener (Get id; Post URL)
/static: Static assets (Get name)
/search: Open search implementation
/sparql: SPARQL query the data (Probably with a UI, some throttling and authentication, restricted on update)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment