Skip to content

upydotmoe/spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 

Repository files navigation

OpenAPI specs for Upy's API

TLDR: This repo aimed only for anyone who want to contribute to our projects or want to use our data on your own application, it's opened to public for now but we planned to restrict its access in the future in order to maintain the traffic requests to our system.



links: Swagger Online Docs  •   JSON formatted


# Generate client code

To generate client code of OpenAPI you can use Swagger Editor, you just need to copy all the content of the YAML definition file from swagger.yml and paste it in the swagger editor.

The next step is go to Generate Client and select typescript-fetch, wait until the download process done. And once the file downloaded, open the ZIP file and put api.ts to api/openapi/ in the front-end source code.

# Further information

For further information or question you can ask me on https://twitter.com/nor1c_.