rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add HTTP API to docs

Browse source
This commit is contained in:
Richard 2021-07-06 15:26:27 +01:00
parent 00531a93bf
commit 19abfff061
4 changed files with 34 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/source/api.rst
View file

@ -6,4 +6,10 @@ 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``.
.. note:: We should have an online copy of the API SwaggerUI documentation up soon.
.. note:: We should have an online copy of the API SwaggerUI documentation up soon.
The API is now also detailed below, or there is a more interactive version of the docs statically compiled using ReDoc_
.. openapi:: ../build/swagger.yaml
.. _ReDoc: api_redoc.html