https://github.com/radiokot/wfeed-api

API for the Warm feed app. Replaces the original backend written in PHP
https://github.com/radiokot/wfeed-api

jackson javalin jsonapi koin kotlin mysql openapi

Last synced: 4 days ago
JSON representation

API for the Warm feed app. Replaces the original backend written in PHP

• Host: GitHub
• URL: https://github.com/radiokot/wfeed-api
• Owner: Radiokot
• Created: 2021-12-06T12:22:07.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-09T20:24:23.000Z (over 2 years ago)
• Last Synced: 2024-11-21T16:48:00.599Z (2 months ago)
• Topics: jackson, javalin, jsonapi, koin, kotlin, mysql, openapi
• Language: Kotlin
• Homepage: https://radiokot.com.ua/p/feed
• Size: 538 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Warm Feed API

Implements read-only API for the [Warm feed app](https://radiokot.com.ua/p/feed/). 

The database is being maintanined by the [Updater](https://github.com/Radiokot/wfeed-updater/).

There are both legacy and JSONAPI implementations.

## Endpoints

All the JSONAPI dates are in UTC and formatted unsing ISO 8601 instant format, e.g. `2011-12-03T10:15:30Z`.

All the legacy dates are in UTC unixtime.

Check out [Warm feed JSONAPI reference](http://docs.feed.radiokot.com.ua/)

### Legacy categories

`GET /categories`

### Legacy posts

`GET /get`

## Run

```bash

DB_HOST=localhost \

DB_PORT=3306 \

DB_NAME=feed \

DB_USER=*** \

DB_PASSWORD=*** \

PORT=**optional** \

java -Dlog4j.configuration=file:build/libs/logging.properties -jar build/libs/api.jar

```