README.md

Monki Projects OpenAPI Specifications

This project contains OpenAPI specifications for all Monki Projects' APIs.

Tip: Some badges are clickable links, try to use them if you're searching for something.

Overview

Monki Projects API

Monki Projects API is the main API grouping together all of Monki Projects' APIs.

Version	Base URL	Specification file	Clients	Documentation
1	api.monkiprojects.com/v1	specs/monki-projects-api-v1.yaml	Swift: monki-projects-api-client-swift	docs.monkiprojects.com/monki-projects-api-specs

Users API

The Users API handles actions related to user management.

Version	Base URL	Specification file	Clients	Documentation
1	api.monkiprojects.com/v1	specs/users-api-v1.yaml	Swift: monki-projects-api-client-swift (UsersAPI)	docs.monkiprojects.com/monki-projects-api-specs

Places API

The Places API handles actions related to place and map management.

Version	Base URL	Specification file	Clients	Documentation
1	api.monkiprojects.com/v1	specs/places-api-v1.yaml	Swift: monki-projects-api-client-swift (PlacesAPI)	docs.monkiprojects.com/monki-projects-api-specs

Useful diagrams

Diagrams are automatically generated using Kroki.

Place submission

Technical aspects

HTTPS

For security reasons, all Monki Projects' APIs force HTTPS

Contributing

Merge OpenAPI specification files

To merge OpenAPI specification files, just run ./merge.sh in a terminal.