api-collap-fs-uploader

This module makes it easy to upload new or updated api swagger spec to api portal.

Prerequisites

• Java 8
• Maven
• Git

Mandatory custom property in Swagger/OpenAPI spec

Every API spec must be linked to an existing application. For the uploader module to upload API spec under specific application, a custom property x-app-id must be made available under info section of spec to be uploaded. Refer to sample snippet below:

openapi: "3.0.0"
info:
  version: 1.0.0
  title: API Collab - Server
  x-app-id: 1 # Custom property for application id
  license:
    name: MIT
  ....
  ....

To know more about custom attributes in swagger spec, refer to OpenAPI extensions

Running tests locally

mvn clean package

Deploy

java -jar target\fs-uploader.jar

Configuration

File upload directory

${java.io.tmpdir}/api_input folder is scanned for changes by default. This can be changed with upload.baseDir command line argument.

Api portal base url

Default portal base url is http://localhost:8080. This can be changed with upload.portal.protocol, upload.portal.host, upload.portal.port command line arguments.

java -jar target\fs-uploader \
    --upload.baseDir=F:\\dev\\api_upload_dir \
    --upload.portal.protocol=https \
    --upload.portal.host=apiportal.com \
    --upload.portal.port=8443