Add an initial @nqminds/nist-brski-controller-server package.
This contains a RESTful API server for controlling the NIST BRSKI demo.
Currently, everything is mocked, but it does have a fully-specced OpenAPI 3.0.0 spec, so that people can implement a client properly.
Authentication/security is currently missing from the API. In my opinion, I don't think we need it, since all of the routes seem to be relatively safe, but we can add it in later if needed.
To see what the OpenAPI spec looks like, copy the node-packages/controller-server/openapi.yaml into https://editor.swagger.io/
Questions for reviewers
@mereacre, does this kind of API make sense from a BRSKI perspective?
@anthonymccaigue and @ashleysetter, you two are the proper full-stack engineers here :smile: Anything basic I'm missing here? We're planning on using this API to make a web-app like in https://github.com/nqminds/nist-brski/issues/5
mereacre
commented
1 year ago
Add an initial
@nqminds/nist-brski-controller-serverpackage.This contains a RESTful API server for controlling the NIST BRSKI demo.
Currently, everything is mocked, but it does have a fully-specced OpenAPI 3.0.0 spec, so that people can implement a client properly.
Authentication/security is currently missing from the API. In my opinion, I don't think we need it, since all of the routes seem to be relatively safe, but we can add it in later if needed.
To see what the OpenAPI spec looks like, copy the
node-packages/controller-server/openapi.yamlinto https://editor.swagger.io/Questions for reviewers
@mereacre, does this kind of API make sense from a BRSKI perspective?
@anthonymccaigue and @ashleysetter, you two are the proper full-stack engineers here :smile: Anything basic I'm missing here? We're planning on using this API to make a web-app like in https://github.com/nqminds/nist-brski/issues/5