search

pwndoc / pwndoc

Pentest Report Generator
https://pwndoc.github.io/pwndoc
MIT License
2.22k stars 417 forks source link

Provide API documentation #183

Closed homedirectory closed 1 year ago

homedirectory commented 3 years ago

There is an API endpoint at https://address:port/api and I can see HTTP traffic hitting that endpoint. Yet I could not find any reference to the API documentation.

yeln4ts commented 3 years ago

There isn't one yet. I looked at solutions to generate an API documentation automatically but I didn't find the time yet.

paul1278 commented 2 years ago

@yeln4ts what about a swagger-specification using a YAML-file? Of course that is not automatic, but if you agree I could start writing one when I have some spare time.

rafchillons commented 1 year ago

By when do you plan to release the API documentation, perhaps within the next few months?

MaxNad commented 1 year ago

Partial documentation is now available at https://pwndoc.github.io/pwndoc/api/

The endpoints and expected parameters will get more documentation with time, but you can get most of the info there already.