API Documentation as HTML

Not applicable

I want to publish my api spec as an HTML in the developer portal .As smart docs does not take html as input

Please tell the process to do that .

0 3 320
3 REPLIES 3

@Arpit Sharma

Any reason why you don't want to use smartdocs ?

Coming to your query,

You can just create a new content type called "api-docs" & then add your HTML to body of the content form by selecting format as "Full HTML".

Add Content - Type :

2414-screen-shot-2016-04-15-at-125813-pm.png

2415-screen-shot-2016-04-15-at-125843-pm.png

Add Content :

2416-screen-shot-2016-04-15-at-10154-pm.png

2417-text-html.png

Not applicable

@anil sagar

I know this is a old post and things may have changed now,

I am generating html output for my api documentation using swagger json, spring rest docs and ascii doctor in my code pipeline. This output contains my entire API documentation including static notes.

Instead of using the UI as shown above, Is their a way I can show this html in apigee developer portal where my APIs are listed . Some form of link to documentation or inline is fine .

Also is there a API within Apigee to do this so I can integrate this into my deployment of the API into apigee edge.

Any help is appreciated.

bdavolls
Participant II

This post is way old - Has there been an update to this? We want to customise our API Documentation on Edge (cloud)