Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.1 KB

APIs.md

File metadata and controls

41 lines (24 loc) · 1.1 KB

API documentation

Table of contents

Get started

Run the application and open SwaggerUI at http://localhost:8080

  • Use the above link to test and get detail information about APIs in this project via UI.
  • Another approach is to use Postman to test APIs.

api_example.png

Authentication

When run the application, the default user admin is created with:

  • username: admin@linkking.com
  • password: admin

Any request to the API must be authenticated with JWT token.

Use the above credential to make a POST request to /api/v1/auth/authenticate to get the JWT token.

authenticate.png

Json template

All the json body template is included in SwaggerUI.

json_body_template.png

Read next

Check out the Role & Permission Documentation to see the list of public APIs, roles and permissions.