search

gingeleski / cucumber-spring-security-tests

Cucumber/BDD security tests example for Java (Spring Boot API).
9 stars 8 forks source link

Add OpenAPI/Swagger spec #31

Closed gingeleski closed 4 years ago

gingeleski commented 4 years ago

For the example application, add an OpenAPI/Swagger spec.

https://swagger.io/

gingeleski commented 4 years ago

Opted for OpenAPI (version 3.0) in lieu of Swagger (version 2.0).

Note that what I just committed isn't necessarily comprehensive or accurate. Will attempt to make it so before closing this issue.

gingeleski commented 4 years ago

I don't even really remember where I left the application logic, so...

Current API state, based off controller skimming


UserController.java

  POST /login
    AuthZ @PermitAll
    Params username, password

  GET /logout
    AuthZ isAuthenticated()

RoomController.java

  GET /rooms
    AuthZ isAuthenticated()

  GET /rooms/{roomName}
    AuthZ isAuthenticated()

  GET /rooms/{roomName}/availability
    AuthZ isAuthenticated()

AppointmentController.java

  (nothing right now)
gingeleski commented 4 years ago

This should be kept up-to-date with API changes from here on.