Comments (12)
Once you make changes in swagger file, please do the following steps from the README to update the generated index.html
file with your changes:
// If you don't have redoc-cli, install it
$ npm i -g redoc-cli serve
$ redoc-cli build swagger.yaml -o index.html
$ serve -s .
from docs.
Is it a RESTful API? If yes, where I can start?
from docs.
Hey @zahertalab ,
Yes, it is a restful API. The API routes are all part of the api directory and they call code in the controllers directory which can be used as a reference for validations etc.
from docs.
I wonder if there is some swagger or open API UI available?
from docs.
We don't have Swagger/OpenAPI set up as of today, but if you can set up a swagger yaml, I'd be happy to have it part of the project to make it more accessible to folks in the future! 👍
Update: @zahertalab We now have a new swagger documentation repo: https://github.com/Slash-Go/Docs ... I've moved the issue to the new repo. Docs are currently served at https://docs.slashgo.link/ from this repo.
from docs.
Hi @navinpai I want to work on this. Just to summarize, you want the swagger documentation to be updated with other end points like Auth
, Organizations
etc.
from docs.
Hi @navinpai I want to work on this. Just to summarize, you want the swagger documentation to be updated with other end points like
Auth
,Organizations
etc.
Yes, that's right... It would be great to have the swagger.yaml updated with all the endpoints and responses
Thanks in advance!
from docs.
from docs.
Sure...is there one location/file where I can get all the endpoints and responses. I remember seeing some of it on different folders.
The API routes are all part of the api directory and they call code in the controllers directory which can be used as a reference for validations etc. Sorry we don't have a single path for it yet, but we're hoping this repo becomes that single source of truth for the API 😸
from docs.
localhost://3000 doesn't reflect the changes I make on the swagger.yaml file. How can I sync it locally, so I can validate my work?
from docs.
Hi @navinpai, I have done some baseline work for 'auth' endpoints. Need some inputs and feedback before I proceed further . I will create a pull request, please have a look.
from docs.
Hello, do you still need help with the documentation? I see the last update was 28 days ago.
from docs.
Related Issues (1)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docs.