RealWorld API Spec

Features

General functionality:

• Authenticate users via JWT (login/signup pages + logout button on settings page)
• CRU* users (sign up & settings page - no deleting required)
• CRUD Articles
• CR*D Comments on articles (no updating required)
• GET and display paginated lists of articles
• Favorite articles
• Follow other users
• Global Error Response

Endpoints

https://gothinkster.github.io/realworld/docs/specs/backend-specs/endpoints

https://realworld-docs.netlify.app/docs/specs/backend-specs/endpoints

Running API tests locally

To locally run the provided Postman collection against your backend, execute:

APIURL=http://localhost:${port}/api 
$ ./run-api-tests.sh

For more details, see run-api-tests.sh.

Test

$ ./gradlew test

Database

Postman

Swagger 3.0 With Authorize

please input bearer ${TOKEN}

License

All of the codebases are MIT licensed unless otherwise specified.