File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Load Diff This file was deleted.
Original file line number Diff line number Diff line change @@ -12,13 +12,6 @@ The `openapi.yaml` file is a machine-readable API specification that describes a
1212
1313### 1. View Interactive Documentation
1414
15- #### Online (GitHub Pages)
16- The API documentation is automatically published to GitHub Pages:
17-
18- 🔗 ** https://zmoog.github.io/classeviva/ **
19-
20- This is updated automatically whenever the ` openapi.yaml ` file is changed on the ` main ` branch.
21-
2215#### Using Swagger UI Online
23161 . Go to https://editor.swagger.io/
24172 . Click "File" → "Import File"
Original file line number Diff line number Diff line change @@ -4,11 +4,9 @@ Classeviva is a Go library and CLI tool to access the popular school portal http
44
55## OpenAPI Specification
66
7- 📖 ** [ View Interactive API Documentation] ( https://zmoog.github.io/classeviva/ ) **
8-
97An [ OpenAPI specification] ( openapi.yaml ) is available that documents the Classeviva API endpoints. This specification can be used to:
108
11- - ** View interactive API documentation** - Automatically published to [ GitHub Pages ] ( https://zmoog.github .io/classeviva / )
9+ - ** View interactive API documentation** - Use 3rd party tools like [ Swagger Editor ] ( https://editor.swagger .io/ ) or [ Redocly ] ( https://redocly.com /)
1210- ** Generate API clients** in your preferred programming language using tools like [ OpenAPI Generator] ( https://openapi-generator.tech/ )
1311- ** Understand API endpoints** and request/response formats
1412
You can’t perform that action at this time.
0 commit comments