Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(rs.swagger:define-swagger-resource api) does not work. #13

Open
amherag opened this issue Apr 28, 2021 · 2 comments
Open

(rs.swagger:define-swagger-resource api) does not work. #13

amherag opened this issue Apr 28, 2021 · 2 comments

Comments

@amherag
Copy link

amherag commented Apr 28, 2021

Hello

I defined an API following the example in demo/. I was able to successfully run the API and everything is working wonderfully. Then I followed the instructions from the documentation to generate the API documentation using Swagger and I'm getting an error. After executing:

(rs.swagger:define-swagger-resource api)

where api is the symbol's name I used to create the API with rest-server:define-api. I get the following error:

SWAGGER is not a valid api option

I'll keep looking into this, but I assume I'll help the community by documenting my issue and also maybe the community has already an answer to this problem and you can save me some hours of research and trial and error :D

@mmontone
Copy link
Owner

Hello Amaury,

the Swagger api documentation generator needs to be reviewed. I had something working at some point, but then I moved on to other things.

Also, this project documentation in general needs to be worked on, and you cannot rely on it at the moment. So, apologies. The source code is the true guide at this moment.

As for api docs, you can try this:

(start-api-documentation 'users-demo-api "localhost" 9096)

But they are very far from a Swagger docs .

@amherag
Copy link
Author

amherag commented Apr 29, 2021

Ah, I see. Thank you for your fast reply and for the help!

I'm not sure if you want this issue to remain open. I will let you decide that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants