A documentation for Sympla API

About   |    Technologies   |    Installation   |    Configuration   |    Documentation   |    License

🔖 About

Doc: Sympla API is a documentation for Sympla API

💻 Technologies

• OpenAPI
• Insomnia
• Sympla API

📦 Installation

# clone the repository
git clone https://github.com/gabrielmaialva33/doc-sympla-integration.git
# enter the directory
cd doc-sympla-integration
# use inso to generate the documentation
inso generate --spec doc-sympla-integration.yaml --type openapi --output doc-sympla-integration.json

🔧 Configuration

open the doc-sympla.yaml file in insomnia or postman and change the host and basePath

host: "api.sympla.com.br"
basePath: "/public/v3"

📝 Documentation

# Use insomnia or postman to test the routes

file `doc-sympla.yaml` in root directory

✍️ Author

Maia

License

MIT License