search

BESTRobotics / registry

A national registry for information pertaining to BESTRobotics
0 stars 0 forks source link

API Design #5

Closed the-maldridge closed 5 years ago

the-maldridge commented 5 years ago

@scauthen with the two of us working on this from effectively opposite ends, I think its probably pretty important that we use some kind of documentation around the API between the frontend and the backend.

What do you think about using OpenAPI specifications?

scauthen commented 5 years ago

I am good with this.

the-maldridge commented 5 years ago

I am following this standard for now: https://www.restapitutorial.com/lessons/httpmethods.html

I probably should write the actual openapi spec, but the file format for it is somewhat confusing to me at the moment, so I may just generate it from the finished server.