Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !12957

[typescript] typescript client generator supports import mapping

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/uesyn/support-typescript-importmapping into master Jul 20, 2022
  • Overview 20
  • Commits 7
  • Pipelines 0
  • Changes 63

Created by: uesyn

typescript-node client generator supports import mapping, but typescript client generator doesn't. This PR makes typescript client generator support import mapping feature.

I verified that import mapping works correctly in the following way.

  • ./bin/generate-samples.sh generates no changes because which doesn't use import mapping.
  • Generate sample codes with import-mapping.
$ java -jar ./modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g typescript --import-mappings=Tag="../../types" -o out -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml --additional-properties=useInversify=true

$ grep -1 -r "../../types" out
out/models/ObjectSerializer.ts-export * from './Pet';
out/models/ObjectSerializer.ts:export * from '../../types';
out/models/ObjectSerializer.ts-export * from './User';
--
out/models/ObjectSerializer.ts-import { Pet     , PetStatusEnum   } from './Pet';
out/models/ObjectSerializer.ts:import { Tag } from '../../types';
out/models/ObjectSerializer.ts-import { User } from './User';
--
out/models/all.ts-export * from './Pet'
out/models/all.ts:export * from '../../types'
out/models/all.ts-export * from './User'
--
out/models/Pet.ts-import { Category } from './Category';
out/models/Pet.ts:import { Tag } from '../../types';
out/models/Pet.ts-import { HttpFile } from '../http/http';
--
out/services/ObjectParamAPI.ts-import type { Pet } from '../models/Pet';
out/services/ObjectParamAPI.ts:import type { Tag } from '../../types';
out/services/ObjectParamAPI.ts-import type { User } from '../models/User';
--
out/services/ObservableAPI.ts-import { Pet } from "../models/Pet";
out/services/ObservableAPI.ts:import { Tag } from "../../types";
out/services/ObservableAPI.ts-import { User } from "../models/User";
--
out/services/PromiseAPI.ts-import { Pet } from "../models/Pet";
out/services/PromiseAPI.ts:import { Tag } from "../../types";
out/services/PromiseAPI.ts-import { User } from "../models/User";
--
out/types/ObjectParamAPI.ts-import { Pet } from '../models/Pet';
out/types/ObjectParamAPI.ts:import { Tag } from '../../types';
out/types/ObjectParamAPI.ts-import { User } from '../models/User';
--
out/types/ObservableAPI.ts-import { Pet } from '../models/Pet';
out/types/ObservableAPI.ts:import { Tag } from '../../types';
out/types/ObservableAPI.ts-import { User } from '../models/User';
--
out/types/PromiseAPI.ts-import { Pet } from '../models/Pet';
out/types/PromiseAPI.ts:import { Tag } from '../../types';
out/types/PromiseAPI.ts-import { User } from '../models/User';

close: https://github.com/OpenAPITools/openapi-generator/issues/12907

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/uesyn/support-typescript-importmapping