Add rest api basics #486
Add rest api basics #486
Conversation
|
Done:
Todo:
|
| </head> | ||
| <body> | ||
| <div id="swagger-ui"></div> | ||
| <script src="/js/swagger-ui-bundle-4.5.0.js" crossorigin></script> |
There was a problem hiding this comment.
As I mentioned before, it would be better to install swagger as an NPM package; maybe this is a good opportunity to do so?
There was a problem hiding this comment.
sadly no, I am glad I have time to implement this at all, the additional hours it would probably take to set npm up and configure everything is not in my budget
| function addApiRoutes(FastRoute\RouteCollector $routeCollector) : void | ||
| { | ||
| $routeCollector->addRoute('GET', '/openapi.json', [Api\OpenApiController::class, 'getSchema']); | ||
| $routeCollector->addRoute('GET', '/users/{username:[a-zA-Z0-9]+}/history', [Api\HistoryController::class, 'getHistory']); | ||
| } |
There was a problem hiding this comment.
If you're going to add authentication, try to do that by adding middleware in the routes here, instead of adding an if statement in every controller method in the ApiController.
There was a problem hiding this comment.
I have not time to look into how to integrate a middleware here atm
|
So I am done with the main implementation as far as I see. I will refactor the |
You can try out the new swagger UI for openapi schema at for example http://127.0.0.1/docs/api
You can get the openapi schema as json from http://127.0.0.1/api/openapi.json