square / fdoc

Documentation format and verification
Other
379 stars 59 forks source link

Document how to manage versioned API #50

Closed knightq closed 11 years ago

knightq commented 11 years ago

When a v1 version of an API exits, v0 should still be kept online and documented, but how do you manage this from a documentation point of view in your directory tree structure?

It would be very useful to have a real-world example of versioned API.

zachmargolis commented 11 years ago

A common thing is to add the version somewhere in the path, ex api/v1/some-thing, so then fdoc will let you have separate folders and new endpoints. I'd recommend that approach.