12 lines
No EOL
732 B
ReStructuredText
12 lines
No EOL
732 B
ReStructuredText
HTTP API
|
|
========
|
|
|
|
Live documentation
|
|
------------------
|
|
|
|
Full, interactive Swagger documentation for your microscopes web API is available from the microscope itself. From any browser, go to ``http://{your microscope IP address}/api/v2/docs/swagger-ui``.
|
|
|
|
The API is described in an OpenAPI description, available at ``http://{your microscope IP address}/api/v2/docs/openapi.yaml``. It is also available from our `build server`_. It can be conveniently viewed using Redoc, for example `link to test OpenAPI rendering`_
|
|
|
|
.. _`build server`: https://build.openflexure.org/openflexure-microscope-server/
|
|
.. _`link to test OpenAPI rendering`: https://redocly.github.io/redoc/?url=https://build.openflexure.org/temp/rwb34/swagger.yaml |