{ Community }
  • Academy
  • Docs
  • Developers
  • Resources
    • Community Articles
    • Apigee on GitHub
    • Code Samples
    • Videos & eBooks
    • Accelerator Methodology
  • Support
  • Ask a Question
  • Spaces
    • Product Announcements
    • General
    • Edge/API Management
    • Developer Portal (Drupal-based)
    • Developer Portal (Integrated)
    • API Design
    • APIM on Istio
    • Extensions
    • Business of APIs
    • Academy/Certification
    • Adapter for Envoy
    • Analytics
    • Events
    • Hybrid
    • Integration (AWS, PCF, Etc.)
    • Microgateway
    • Monetization
    • Private Cloud Deployment
    • 日本語コミュニティ
    • Insights
    • IoT Apigee Link
    • BaaS/Usergrid
    • BaaS Transition/Migration
    • Apigee-127
    • New Customers
    • Topics
    • Questions
    • Articles
    • Ideas
    • Leaderboard
    • Badges
  • Log in
  • Sign up

Get answers, ideas, and support from the Apigee Community

  • Home /
  • Developer Portal (Drupal-based) /
avatar image
9

APIs for publishing SmartDocs on Developer Portal  

  • Export to PDF
gkoli123 created · Aug 25, 2016 at 01:54 AM · 2.4k Views · edited · Aug 25, 2016 at 01:56 AM

There have been a lot of requests to enable APIs for SmartDocs module on Developer Portal to automate the rendering process.

Here is the module that we have created : https://github.com/apigeecs/smartdocs_service

You would install this module like any other drupal contrib module. It would go under sites/all/modules/ folder and will need to be enabled from the Modules section on your developer portal.

This module is provided as an example only for the community, and it is supported with best-effort via GitHub issues or community.apigee.com. If you find an issue please report it on the GitHub or create pull requests if you have patches.

Module exposes an api to create a SmartDocs model, import OpenAPI (json, yaml) Or WADL specification and to render it.

Rendering is a two step process, first step is to queue the items to be published and on cron run the queue items are processed.

The APIs exposed by this module are documented in the README file.

thub.nodes.view.add-new-comment
Portal - DrupalSmartDocsPortals - SmartDocs
Add comment Show 4
10 |5000 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by Apigeeks only
  • Viewable by the original poster
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users
avatar image williamssean ♦ · Aug 25, 2016 at 02:36 AM 0
Link

Thanks @Gitesh Koli.

I noticed that you can render the model, but does rendering it also publish it?

@Leonardo Ferrreira Can you review this module and try it out? You can post comments/issues on the Github page.

avatar image gkoli123 ♦ williamssean ♦ · Aug 25, 2016 at 04:56 AM 0
Link

Yes it publishes it as a part of rendering. We are trying to keep this simple.

avatar image Leonardo Ferrreira williamssean ♦ · Aug 25, 2016 at 03:53 PM 0
Link

This is awesome! That is what I was looking for!
@Gitesh Koli does it "unpublish" the previous version of an openAPI doc when rendering a new one ?

avatar image gkoli123 ♦ Leonardo Ferrreira · Aug 26, 2016 at 10:53 PM 0
Link

It should.

Article

Contributors

avatar image

Follow this article

45 People are following this .

avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image

Navigation

APIs for publishing SmartDocs on Developer Portal

Related Articles

Content Access Control on Developer Portal SmartDocs Documentation

Exception thrown while creating Smart Docs using JSON

Documenting SOAP APIs on Devportal using the WSDL Docs Module - New Release

Documenting SOAP APIs on Devportal using the WSDL Docs Module

How to customize SmartDocs so that I can test against different environments from the same page

SmartDocs role based access control

SmartDocs - A custom module to your rescue - Fix for SmartDocs issues

SmartDocs and Swagger UI - A Comparison

How to add a left nav to SmartDocs Method page to list all operations of the current model

Apigee Developer Portal - Go Live Check List

  • Products
    • Edge - APIs
    • Insights - Big Data
    • Plans
  • Developers
    • Overview
    • Documentation
  • Resources
    • Overview
    • Blog
    • Apigee Institute
    • Academy
    • Documentation
  • Company
    • Overview
    • Press
    • Customers
    • Partners
    • Team
    • Events
    • Careers
    • Contact Us
  • Support
    • Support Overview
    • Documentation
    • Status
    • Edge Support Portal
    • Privacy Policy
    • Terms & Conditions
© 2021 Apigee Corp. All rights reserved. - Apigee Community Terms of Use - Powered by AnswerHub
  • Anonymous
  • Sign in
  • Create
  • Ask a question
  • Create an article
  • Post an idea
  • Spaces
  • Product Announcements
  • General
  • Edge/API Management
  • Developer Portal (Drupal-based)
  • Developer Portal (Integrated)
  • API Design
  • APIM on Istio
  • Extensions
  • Business of APIs
  • Academy/Certification
  • Adapter for Envoy
  • Analytics
  • Events
  • Hybrid
  • Integration (AWS, PCF, Etc.)
  • Microgateway
  • Monetization
  • Private Cloud Deployment
  • 日本語コミュニティ
  • Insights
  • IoT Apigee Link
  • BaaS/Usergrid
  • BaaS Transition/Migration
  • Apigee-127
  • New Customers
  • Explore
  • Topics
  • Questions
  • Articles
  • Ideas
  • Badges