API prefix

[rwb27]

This adds a configuration parameter for the API prefix. This will allow us to have things visible at, for example, /api/v3/stage.

The prefix applies to LabThings endpoints too, for example /thing_descriptions/ would become /api/v3/thing_descriptions.

I've added tests for

• Validation of the prefix
• LabThings endpoints (checked by inspecting app.routes)
• Use with a TestClient (by adding a prefix in test_thing_client).

If the config parameter is not used, nothing changes.

In doing this, I've swapped functions where I pass the app around for ones that use APIRouter to pass the routes in a nicer way. I have not tackled Thing.add_to_fastapi because that will be a more involved change.

I added some tests for the /things/ and /thing_descriptions/ endpoints, and in so doing discovered I needed to fix /things/. I've done this by adding an endpoint name for the thing description of each thing: it's now named things.{name}, which means we can get its URL with url_for. It would be nice to do this for all endpoints, but that's a job for another time.

Closes #264

[barecheck]

Barecheck - Code coverage report

Total: 96.39%

Your code coverage diff: 0.05% ▴

Uncovered files and lines

File	Lines
src/labthings_fastapi/actions.py	508-509, 522, 547-548, 723, 865-866, 869, 872, 920
src/labthings_fastapi/server/__init__.py	197, 211-214
src/labthings_fastapi/thing.py	263, 283, 335-337, 369, 457

[julianstirling]

For this I think we do want to do a bit of testing before merge. I would be very keen to have the microscope running on this branch, so we know things are covered.

[rwb27]

I've rebased this, which means it will test against the microscope. However, as this is a feature that's off by default, we're only tested that nothing is broken with the API prefix left empty.

It would be nice to check that the OFM functions as expected with an API prefix specified. That may not affect the unit tests at all, possibly it only affects the integration and lifecycle tests that refer to the config files. I'll try to have a play - if it's as contained as I hope, that branch should not be a big pain to rebase as needed. The web app will need manual testing for now.

The OFM test above will have checked that the changes to use APIRouter to tidy up the endpoints have had the intended effect.