b-reynolds / postie-api

(WIP) A simple REST API for a plain text hosting service

Postie (API)

Postie is an in-development RESTful API for a plain text hosting service.

Getting Started

Installation/Usage

Docker Compose

The easiest way to run the Postie API is using the docker-compose.yml file within the root directory.

docker-compose up

This command will initialize a PostgreSQL database with the Postie schema and start up the API.

The default database credentials, API key and ports can be overridden using the environment variables within this file.

Docker

The api folder contains a Dockerfile that can be used to build a Docker image of the Postie API.

cd api/
docker build -t bornylsdeen/postie . 

Alternatively, you can pull down and use a pre-built image from the Docker Registry.

docker pull bornylsdeen/postie

You can then run the image pointing it towards a PostgreSQL database that has been setup with the Postie database schema (see database/init.sql).

docker run \
  --env POSTIE_PORT=7000 \
  --env POSTIE_API_KEY=postie \
  --env POSTIE_POSTGRES_HOST=jdbc:postgresql://localhost \
  --env POSTIE_POSTGRES_PORT=5432 \
  --env POSTIE_POSTGRES_USER=postie \
  --env POSTIE_POSTGRES_PASSWORD=postie \
  -d \
  bornylsdeen/postie

Java

If you want to run the Postie API outside of Docker you can create a fat JAR using the shadowJar gradle task.

The Postie API has only been tested against Java 1.8

cd api/
./gradlew shadowJar

You can then start up the API using the run command and configure it using the command-line options (environment variables will also work here but the command-line options take precedence).

java -jar /build/libs/api-0.0.1-all.jar run \
  --port 7000 \
  --api-key postie \
  --postgres-host jdbc:postgresql://localhost \
  --postgres-port 5432 \
  --postgres-user postie \
  --postgres-password postie

postie-api's Issues

Implement basic logging and pipeline level API error handling

Reduce docker image size

Ensure resource location headers are set correctly for requests with/without trailing path separators

Use UUID instead of SERIAL for the primary key of the files table

Create command-line interface

Organise paths and controllers

Endpoint names should be pluralised

Make fileTypeId nullable

Write unit tests for FilesPostController

Add further information to the project README

Increase Docker image build speed

Write unit tests for FilesGetController

Create database schema for storing text/code snippets

JSON responses should be formatted

Create REST API for creating/managing files

Setup Gradle Kotlin/JVM project for the Postroom service

Support HTTPS

Improve error handling for FilesPostController

Add more information to the project README

Run Postroom using Docker

Creating a file should result in a 201 response with a resource location header

Set a default password for the Postgres database

Use a relative directory for the PostgreSQL data volume

Provide meaningful error messages if a request for a file fails

Update project and database names

Setup PostgreSQL database for the project

Add error handling to FilesController

Setup Javalin

Write unit test for FilesGetController covering invalid file IDs

Create routes for managing file types

API port and DB credentials should be configurable

Write unit tests for SatchelFileDao

Inject dependencies using class constructors

The files API should be versioned

Setup basic authentication

File type names should not be converted to lowercase

Setup CI using Travis