cezarykluczynski / stapi

STAPI, a Star Trek API
https://stapi.co
MIT License
124 stars 13 forks source link
api openapi rest rest-api spring-batch spring-boot star-trek star-trek-api startrek startrek-api

Build Status codecov Uptime Robot ratio (30 days) License: MIT Maven Central Docker Pulls

About

STAPI is a first public Star Trek API, accessible via REST.

Started as a research project, it turned into a fully working website in 2017. More about the development history can be found here.

STAPI is written in Java. Tests are written in Groovy, and since there are more tests than production code, it shows in GitHub as a Groovy project.

Connecting

STAPI can be accessed freely and without the need of API keys.

API Browser offers a peek into what data STAPI serves.

API overview describes key API concepts.

Swagger editor with STAPI specs loaded can also be used to browser the API.

Clients

Available clients are:

Contributing

Contributions to STAPI are most welcome. Contributing guildlines are available.

Bug reports and feature requests

Please open a GitHub issue describing your case.

Docker

STAPI can be run as a local Docker container. Details can be found on STAPI's Docker Hub page.

Documentation