Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gabrielmaialva33/doc-sympla-integration
Documentação de integração com a API da Sympla
https://github.com/gabrielmaialva33/doc-sympla-integration
docs openapi openapi-specification openapi3 sympla
Last synced: about 1 month ago
JSON representation
Documentação de integração com a API da Sympla
- Host: GitHub
- URL: https://github.com/gabrielmaialva33/doc-sympla-integration
- Owner: gabrielmaialva33
- Created: 2023-08-18T18:19:15.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-08-27T19:06:42.000Z (about 1 year ago)
- Last Synced: 2024-10-01T06:44:34.730Z (about 2 months ago)
- Topics: docs, openapi, openapi-specification, openapi3, sympla
- Homepage:
- Size: 34.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A documentation for Sympla API
About |
Technologies |
Installation |
Configuration |
Documentation |
License
## :bookmark: About
**Doc: Sympla API** is a documentation for [Sympla API](https://developers.sympla.com.br/)
## :computer: Technologies
- **[OpenAPI](https://swagger.io/specification/)**
- **[Insomnia](https://insomnia.rest/)**
- **[Sympla API](https://developers.sympla.com.br/)**
## :package: Installation
```bash
# 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
```
### :wrench: **Configuration**
open the `doc-sympla.yaml` file in insomnia or postman and change the host and basePath
```yaml
host: "api.sympla.com.br"
basePath: "/public/v3"
```
### :memo: **Documentation**
```md
# Use insomnia or postman to test the routes
file `doc-sympla.yaml` in root directory
```
### :writing_hand: **Author**
| [](https://github.com/gabrielmaialva33) |
|-----------------------------------------------------------------------------------------------------------|
| [Maia](https://github.com/gabrielmaialva33) |
## License
[MIT License](./LICENSE)