search

apiaryio / api-blueprint

API Blueprint
https://apiblueprint.org
MIT License
8.64k stars 2.14k forks source link

Blueprint definition in the Meta section for the API version #309

Closed etiennemarais closed 8 years ago

etiennemarais commented 8 years ago

Info

There is a big community drive out there to have versioned api's that keeps the structure stable for clients to consume. I am a big believer in this methodology and I build my api's to have a very specific structure per version, when I take away or edit things that affects the structure, I bump my version so that the clients on the older supported version can still function without any downtime.

Is there a way the META part of the blueprint can be updated to contain a semantic version? Like: v2.0.0, v1.0.3.

Use case

I automatically generate unit tests and routes based on whats in my blueprint file. I would love to generate the versioned transformers I use to specify the data for the responses.

A extended Meta section that contains meta data about the API is more what I am looking for, above is mainly what our team will be using it for but I do recon it will help a lot of people.

etiennemarais commented 8 years ago

I see this is already happening, Closing this ticket was a bit pre-emptive :disappointed: