andrelmlins / freesoccer

:soccer: Free API with results from national soccer competitions
https://www.apifreesoccer.com/
MIT License
35 stars 9 forks source link

Create URL documentation #11

Closed vgeruso closed 4 years ago

vgeruso commented 4 years ago

In this api, a clear documentation of each url could be created, showing its request method, input and output of each, for better understanding of the system users.

Exemple:

resultes of brazilian championship series A

url: http://localhost:4000/scraping/cbf/:competition/results

Parameters:

andrelmlins commented 4 years ago

In this JSON file we have all the api documentation for swagger. We may publish this documentation again. https://github.com/andrelmlins/freesoccer/blob/master/src/config/swagger.json

vgeruso commented 4 years ago

ok, the documentation in JSON generated with swagger is complite, therefore I'll be closing the issue