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

Open API / Swagger specification #52

Open
4n70w4 opened this issue Oct 8, 2020 · 5 comments
Open

Open API / Swagger specification #52

4n70w4 opened this issue Oct 8, 2020 · 5 comments
Labels
enhancement New feature or request

Comments

@4n70w4
Copy link

4n70w4 commented Oct 8, 2020

Hi! It would be very convenient to have a swagger file with a description of all requests and responses.

It would also automatically generate client libraries for any programming language.

https://editor.swagger.io/

image

@xtrime-ru
Copy link
Owner

Its a big task... Need to put all these methods in editor: https://docs.madelineproto.xyz/API_docs/methods/

I cant do it. But will gladly approve such pull request.

@xtrime-ru xtrime-ru added the enhancement New feature or request label Oct 8, 2020
@4n70w4
Copy link
Author

4n70w4 commented Oct 8, 2020

Perhaps this can be somehow automated.

May be need to parse *.json and *.tl files from https://github.com/danog/schemas and generate a swagger.yml based on it.

I assume the documentation repository https://github.com/danog/MadelineProtoDocs is also generated automatically. But I have not yet figured out where the generator code is. One could take it as a basis.

Do you have any information about this?

@4n70w4
Copy link
Author

4n70w4 commented Oct 8, 2020

Okay, I found https://github.com/danog/MadelineProto/tree/master/tools/build_docs

In the near future I will look this and it may turn out on the basis of this to a proof of concept for swagger.yml generator

@xtrime-ru
Copy link
Owner

You can contact madelineProto creator @danog for additional info.

@danog
Copy link
Contributor

danog commented Oct 9, 2020

Seems like fun, I'll take a look tomorrow, if I finish the phpdoc generator, first)))

4n70w4 added a commit to 4n70w4/TelegramApiServer that referenced this issue Oct 11, 2020
The first step for xtrime-ru#52

I will add as far as possible
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants
@danog @xtrime-ru @4n70w4 and others