search

CDRH / api

Codenamed "Apium": An API to access all public Center for Digital Research in the Humanities resources
https://cdrhdev1.unl.edu/api_frontend
MIT License
3 stars 1 forks source link

update open api docs #40

Open jduss4 opened 7 years ago

jduss4 commented 7 years ago

It seems like a noteworthy task

karindalziel commented 7 years ago

Check comments in issue #17 too

jduss4 commented 4 years ago

These days the specification is no longer "swagger," but unfortunately the nice interface we used years ago to build the schema is no longer available. We'll have to investigate new solutions and read the specs in order to update our version.

https://www.openapis.org/

techgique commented 4 years ago

There are some tools and editors documented in their repo: https://github.com/OAI/OpenAPI-Specification/blob/master/IMPLEMENTATIONS.md

techgique commented 1 year ago

Changing our API to be Open API compatible and machine-readable will help make it much easier for people to program access to for other potential front ends and research. I've looked at Open API for work with Open ONI and the structure of the responses is very helpful: https://learn.openapis.org/specification

Also Redoc looks like a very popular tool according to their Tools > Documentation page