Skip to content

fasghq/kanbirds

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kanaria toolbox for rarity ranking

API test

We will use Postman to test endpoint. image For this version of API public web URL generated with SocetXP is https://xivanxv2-hnrsd468js2xt6rq.socketxp.com/.

It is worth to mention that our db in fact contains 2 modules: one for all data connected to kanbirds and another one with API users' data. Second module is required for authorization process and for now it is a preliminary version, which will be finalized in the future.

Registration process within this version looks as following: user signs up and logs in to get authorization token (it has expiration date which also can be modified). With this token user gains access to other commands of 'users' module (such as modification of personal data and so on) and 'birds' module. All commands could be tested with Postman by changing blueprint and request method (POST, GET, etc). By blueprint we mean URL (1) + command part (2):

image

All commands will be described below as the combination of blueprint, request method and request body which should be used to reproduce the command.

User module

Create user: POST + api/v1/users/

image

Login: POST + api/v1/users/login

image Returned token should be used as param in next requests which require authentication.

View own data: GET + api/v1/users/me, requires authentication

Provide token as api-token key value. image

Edit own data: PUT + api/v1/users/me, requires authentication

image

Delete own data: DELETE + api/v1/users/me, requires authentication

image

View all users: GET + api/v1/users/, requires authentication

image

Kanbirds module

View all birds: GET + api/v1/birds/, requires authentication

image

View bird by id: GET + api/v1/birds/id, requires authentication

image

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.1%
  • Shell 0.9%