Hey all! How is everyone else generating API docs ...
# ktore
Evan R.
03/09/2020, 4:20 AMHey all! How is everyone else generating API docs for their ktor servers? Are you writing by hand? Is this a good choice?: https://github.com/nielsfalk/ktor-swagger Is there another tool you prefer?
h
Hampus Londögård
03/09/2020, 7:39 AMCommenting as I'm also super-interested in knowing!
s
sultanofcardio
03/09/2020, 1:55 PMHopefully your post has better luck than mine. The prevailing opinion seems to be that you should be writing the API docs first, and then using it to generate your code. This works up until you need to change the API
e
Evan R.
03/09/2020, 6:29 PMAfter doing some research I think I’m going to develop my docs separately using Apiary’s API Blueprint format since it seems to be well fleshed out along with Snowboard for rendering the docs
5 Views