Skip to content

Latest commit

 

History

History
executable file
·
59 lines (49 loc) · 2.2 KB

README.md

File metadata and controls

executable file
·
59 lines (49 loc) · 2.2 KB
Raw

apigee-smartdocs-maven-plugin

About the Plugin

apigee-smartdocs-maven-plugin is a utility for creating API models and pushing an OpenAPI spec document into the API Catalog module for a Drupal 10-based developer portal, where it can then be rendered into documentation using SmartDocs or another renderer.

The code is distributed under the Apache License 2.0.

NOTE: Log4J libraries are upgraded to v2.17.1 in v2.2.2

TL;DR

  • Version 1.x of this plugin should be used for Drupal 7 version of the Developer portal and the goal is apimodel. For example in your pom.xml 
      <plugin>
      <groupId>com.apigee.smartdocs.config</groupId>
      <artifactId>apigee-smartdocs-maven-plugin</artifactId>
      <version>1.0.8</version>
      <executions>
          <execution>
              <id>smartdocs-deploy</id>
              <phase>install</phase>
              <goals>
                  <goal>apimodel</goal>
              </goals>
          </execution>
      </executions>
  </plugin>
  • Version 2.x of this plugin should be used for Drupal 10 version of the Developer portal and the goal is apidoc. For example in your pom.xml
    <plugin>
        <groupId>com.apigee.smartdocs.config</groupId>
        <artifactId>apigee-smartdocs-maven-plugin</artifactId>
        <version>2.1.0</version>
        <executions>
            <execution>
                <id>smartdocs-deploy</id>
                <phase>install</phase>
                <goals>
                    <goal>apidoc</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

The samples folder provides a Readme with Getting Started steps and commands to hit the ground quickly. Contains samples for Drupal 7 and Drupal 10 version of Developer portal

Support