Skip to content

Releases: metwse/metw-api-v2

Release candidate 1 for version 0.1.0

17 Oct 22:55
@metwse metwse
v0.1.0-rc1
a684c9c

Choose a tag to compare

View all tags
Release candidate 1 for version 0.1.0 Pre-release
Pre-release

First release candidate for v0.1.0.

Provides an immutable, read-only API connected to a static database. Its primary purpose is to serve existing user and post data.

/auth

  • POST /auth/register: Register a new account. Can be disabled with DISABLE_ACCOUNT_CREATION environment variable.
  • POST /auth/login: Log in to an existing account.

/users

  • GET /users/@{username}: Fetch user by username.
  • GET /users/{id}: Fetch user by ID.
  • GET /users/@{username}/profile: Get a user's full profile by username.
  • GET /users/{id}/profile: Get a user's full profile.
  • GET /users/{id}/stats: Get a user's stats (followers, follows, comments).
  • GET /users/{id}/followers: List a user's followers.
  • GET /users/{id}/follows: List users a user follows.

/posts

  • GET /posts/{id}: Get a single post by its ID.
  • GET /posts/{id}/stats: Get stats for a single post (likes, comments).

/threads

  • GET /threads/hot: Get "hot" posts from the main thread.
  • GET /threads/latest: Get the latest posts from the main thread.
  • GET /threads/{id}/hot: Get "hot" posts from a specific thread (e.g., user wall).
  • GET /threads/{id}/latest: Get the latest posts from a specific thread.

Note: As this is a read-only API, endpoints for creating, updating, or deleting content (like making new posts or following users) are not included in this version.

Future Plans

In subsequent release candidates (RCs):

  • The goal is to keep the existing endpoints the same.
  • Tests will be written for these functions to increase code stability.
Loading