Files
openapi-generator/samples/client/petstore/n4js
Ross Bender cf2435f335 Add support for controlling output of OpenAPI Generator version in generated files (#17952)
* add initial openapi config and java generated files

* add java implementation for adding generator version

* regenerate sample client files

* remove tabs

* only show generated version if build info exists

* set build info for batch generation

* update generator doc for new global flag

* use existing property for generator version

* update templates to include generator version

* update templates for better generator version syntax

* revert undesired changes

* regenerate samples for openapi client

* update templates to correct formatting/newlines

* correct description text and add to usage doc

* add generator cli option for all codegen types

* use more concise version info; update existing codegens to support new prop

* correct wrong prop reference

* add initial test coverage for new prop

* update last (scala) templates with new prop

* update samples after upstream merge

* use consistent version output

* use better sample project id/name

* revert using option for generator version in templates
2024-03-09 15:52:08 +08:00
..
2023-05-03 20:50:21 +08:00

Documentation for OpenAPI Petstore

  • API version: 1.0.0

  • Generator version: 7.4.0-SNAPSHOT

This is a sample server Petstore server. For this sample, you can use the api key special-key to test the authorization filters.

Automatically generated by the OpenAPI Generator

Getting started

Configure the following elements:

  • In open-api-n4js.yaml please add under 'additionalProperties':
    • property 'fetchExecuterConstName'
    • property 'fetchExecuterConstImplPath'
  • The generated output directory needs to be augmented with an implementing n4js file

Example

open-api-n4js.yaml

    generatorName: n4js
    outputDir: /working_dir/gen-n4js/
    inputSpec: /working_dir/api-spec/main.yaml
    templateDir: /openapi-generator/modules/openapi-generator/src/main/resources/n4js
    additionalProperties:
      fetchExecuterConstName: "FETCH_EXEC"
      fetchExecuterConstImplPath: "FetchExecuterImpl"

FetchExecuterImpl.n4js

    import {FetchExecuterI} from "api/ApiHelper";

    export public const FETCH_EXEC = new FetchExecuterMock();

    export public class FetchExecuterMock implements FetchExecuterI {
        @Override
        public async run(
            path: string,
            query: ~Object=,
            reqInit: ~Object= {}): ~Object with {get status() : number, json(): Promise<any>} {

            return null;
        }
    }