Why we need to manually publish apis on developer portal?

I mean we need to convert apis using swagger then we have to do it manually? There should be some option to do this automatically.

Solved Solved
1 3 494
1 ACCEPTED SOLUTION

sarthak
Participant V

Hi @Rajat Agarwal

there are two different aspects of publishing an API:

Publishing the documentation which developers will read and play with to understand the APIs.

Publishing the Products/Packages which developers will subscribe to.

The first thing is done using swagger. why?

Because you use swagger to design and model your apis. Now you can import that swagger definition to automatically create the documentations. The initial swagger based api design you will be doing with tools like this: http://apistudio.io/

Swagger is the most popular api definition format available today. There are many many open source projects built on top of that. One of the most prominent ones is to create client codes from the swagger definition.You can also generate server side code from the swagger definition. Learn more about it here: https://github.com/swagger-api/swagger-codegen

In Apigee you can use swagger to define the monitors at health.apigee.com.

You can also use the swagger file to create a proxy in Apigee using utilities like this: https://www.npmjs.com/package/swagger2api.

More and more capabilities like that will come out both in the open source swagger project as well as from Apigee.

So swagger will become your central source of truth for your APIs to generate:

1. Proxy

2. Documentation

3. health Monitors

4. Client SDKs

5. Server side code

and many more things.

You may want to read up articles like this: http://apigee.com/about/blog/engineering/api-first-development-apigee-127-and-swagger-node

http://apigee.com/about/blog/engineering/api-first-development-apigee-127-and-swagger-node-0

Now if you have a proxy defined first you can use https://www.npmjs.com/package/apigee2swagger to generate swagger files from proxy definitions.

View solution in original post

3 REPLIES 3

sarthak
Participant V

Hi @Rajat Agarwal

there are two different aspects of publishing an API:

Publishing the documentation which developers will read and play with to understand the APIs.

Publishing the Products/Packages which developers will subscribe to.

The first thing is done using swagger. why?

Because you use swagger to design and model your apis. Now you can import that swagger definition to automatically create the documentations. The initial swagger based api design you will be doing with tools like this: http://apistudio.io/

Swagger is the most popular api definition format available today. There are many many open source projects built on top of that. One of the most prominent ones is to create client codes from the swagger definition.You can also generate server side code from the swagger definition. Learn more about it here: https://github.com/swagger-api/swagger-codegen

In Apigee you can use swagger to define the monitors at health.apigee.com.

You can also use the swagger file to create a proxy in Apigee using utilities like this: https://www.npmjs.com/package/swagger2api.

More and more capabilities like that will come out both in the open source swagger project as well as from Apigee.

So swagger will become your central source of truth for your APIs to generate:

1. Proxy

2. Documentation

3. health Monitors

4. Client SDKs

5. Server side code

and many more things.

You may want to read up articles like this: http://apigee.com/about/blog/engineering/api-first-development-apigee-127-and-swagger-node

http://apigee.com/about/blog/engineering/api-first-development-apigee-127-and-swagger-node-0

Now if you have a proxy defined first you can use https://www.npmjs.com/package/apigee2swagger to generate swagger files from proxy definitions.

@Rajat Agarwal , Just add to what @sarthak said, Yes we agree there are some manual steps involved in Developer Portal to generate documentation. We tried to minimise manual steps using tools like apigee2swagger & swagger2api. We are working towards EndToEnd Swagger support & we will keep you updated.

Thanks @sarthak and @Anil Sagar