search

veritus / veritus-backend

1 stars 0 forks source link

Infrastructure/document api #59

Closed skabbi closed 7 years ago

skabbi commented 7 years ago

Status

Ready

Description

Adding auto-generated API doc using Django REST Swagger and docstrings to most endpoints. To access the API startup as normal and open http://localhost:8000 in the browser. swagger-pre-auth To see restricted endpoints, i.e. more than just GET, you need to authenticate via Swagger. To do this

  1. Log in using the "/api/v1/rest-auth/login/" endpoint, either using Postman or Swaggers "Try it out!" functionality.
  2. Copy the key in the response, e.g. "fe51f25eb24e4569de21a89241ad64a2155009b8".
  3. Use it to authenticate yourselves using "Token fe51f25eb24e4569de21a89241ad64a2155009b8". swagger-auth

You should now have viewing access to all endpoints.

swagger

Dependencies

Ragnar-H commented 7 years ago

Closes #53

skabbi commented 7 years ago

@AriHrannar I've made the changes you recommended. Please re-review :)

skabbi commented 7 years ago

Pull request merged. Should I delete the branch?

Ragnar-H commented 7 years ago

Pull request merged. Should I delete the branch?

Yes 😊