Forum Discussion

jbulck's avatar
jbulck
New Contributor
10 years ago

What's the purpose of 'Publish'?

Hi *,

 

I did not yet 'publish' any API's.

Yet, the URL's seem to be publicly accessible.

 

Is this by design?

Or do I misunderstand the purpose of 'publish'?

 

Thank you!

J.

  • ponelat's avatar
    ponelat
    10 years ago

    Hi J,

     

    For now all APIs are publically accessible, we'll be introducing private APIs a little later on.

     

    So "Publishing" is about making your API version fixed. 

    The idea is, once you publish an API with a version, it'll never change. Its a contract between the API and its users.

    In SwaggerHub it simply sets the API as readOnly from that point on.

     

    Here's a quick workflow...

    Create an API definition.

    Work on it, until its ready to be used in the wild.

    Implement the API (there are codegen tools available).

    Publish the API (just that version, by the way).

    Now your API is set/cast/fixed.

    Users who look for YourAPI v1.0.2, will always see the same API specification.

     

    Then you work on the next iteration, with a newer version - to be published when ready.

     

    We'll also be introducing more lifecycles to the API flow, and would love to hear your thoughts :)

     

    Josh

  • ponelat's avatar
    ponelat
    Staff
    10 years ago

    Hi J,

     

    For now all APIs are publically accessible, we'll be introducing private APIs a little later on.

     

    So "Publishing" is about making your API version fixed. 

    The idea is, once you publish an API with a version, it'll never change. Its a contract between the API and its users.

    In SwaggerHub it simply sets the API as readOnly from that point on.

     

    Here's a quick workflow...

    Create an API definition.

    Work on it, until its ready to be used in the wild.

    Implement the API (there are codegen tools available).

    Publish the API (just that version, by the way).

    Now your API is set/cast/fixed.

    Users who look for YourAPI v1.0.2, will always see the same API specification.

     

    Then you work on the next iteration, with a newer version - to be published when ready.

     

    We'll also be introducing more lifecycles to the API flow, and would love to hear your thoughts :)

     

    Josh