Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make endpoints in API responses full URLs #142

Open
techgique opened this issue Aug 2, 2023 · 0 comments
Open

Make endpoints in API responses full URLs #142

techgique opened this issue Aug 2, 2023 · 0 comments

Comments

@techgique
Copy link
Member

The endpoint(s) keys have values which are relative URLs from the app root. This means to browse between them in the browser, one has to type them in. Full URLs are clickable and make browsing much easier.

https://cdrhapi.unl.edu/v2/

endpoints:
0 | "/"
1 | "/items"
2 | "/item/{id}"
3 | "/collections"
4 | "/collection/{collection}/info"
5 | "/collection/{collection}/item/{id}"

The template URLs obviously can't be made into full URLs, but making the others clickable would make browsing to them much easier. The template URLs would be full URLs at the parent endpoints such as https://cdrhapi.unl.edu/v2/collections

endpoint | "/v2/collection/habeascorpus"

The Chronicling America API and recent reintroduction as the Open ONI Chronam API highlighted how much more convenient browsing an API in the browser can be with full URLs:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant