Home

About

STAPI, a Star Trek API, is an attempt to create public Star Trek API, similar to what Star Wars API and PokeAPI accomplished.

Note: this is still a work in progress, not suitable for production use.

Topics

Consume STAPI

• Quick start - all the information necessary to use STAPI, with example requests
• Contracts - human and machine-readable description of API's endpoints
• Clients - how to connect to STAPI

Run own instance of STAPI

• Basic setup
• Deployment - how to deploy to Tomcat

Contribute to STAPI

• Contributing guidelines
• Development - how to run STAPI locally
• Configuration - what could be configured using properties
• Gradle tasks - custom Gradle task list

Other topics

• Work progress - what is done, and what's yet to be done
• Architecture overview
• Coding conventions
• Scheduled tasks