Basketball-Competition-Dashboard / Project

Backend programs
0 stars 0 forks source link

Generates Web API documentation programmatically with extra tests #3

Closed AsherJingkongChen closed 4 months ago

AsherJingkongChen commented 4 months ago

Generates Web API documentation programmatically with extra tests

Description

I introduced swagger-ui-py to generate Web API documentation from our OpenAPI configuration.

Besides, I added a heartbeat endpoint for testing purposes, with manual tests run for /ping and /data endpoints.

The repository doc is also added as a sub-module due to the necessity of documentation generation.

Motivation or Context

I removed unnecessary artifacts which are challenging to update. Their functionalities are replaced by swagger-ui-py.

Checklist

Item Is checked? Description
Explanation O My changes are well-explained.
Documentation O My works are well-commented or clear.
Tests O I have added tests or reports to cover my changes.