geekzonehq / api

The Geek.Zone API specification. Used for communication between separate projects, e.g. Web and Mobile

API

The Geek.Zone API specification. Used for communication between separate projects, e.g. Web and Mobile

This project contains the specification of the API only, no implementations. The API is specified using OpenAPI v3.1.0, which defines a standard, programming language-agnostic interface description for HTTP APIs.

Usage

The OpenAPI specification can be used in tools such as Postman or Swagger to document and mock the API during development. It can also be used by other tools to automatically generate code, or to generate test suites for implementations of the API.

Contributing

If you need any help, please log an issue and one of our team will get back to you.

PRs are welcome. Get started by reading our contributing directions.

This is a project by the Geek.Zone community. If you like this project, please become a sponsor!

License

• This, and all Geek.Zone code, is licensed under the GNU General Public License v3.0.
• The license owner is Geek.Zone.
• The full text of the license can be found in the LICENSE file.