-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Dummy client generated * Adding dummy versions, my IDE crashed * Making my first actual requests * Creates first version of API Generator for Jetbrains Client * Adds generated API files * Adds more complex API definition * Adds basic supporting files * Adds empty environment file for variables * Adds basic README * Adds minimal set of values in env file` * Adds minimal support for API Key header * Adds Adyen API sample * Add null checks on code * Simplifies the generator, cleans output * Improves README * Fix minor issues with README * Removes API file and config used for local testing * Remove leftover logging file * Disables tests as I find how to write them * Sets generator as experimental * Add new generator language enum value * Adds generator doc file * Adds generators main file * Removes unused method. Adds my name * Adding Jetbrains HTTP Client to the README
- Loading branch information
Showing
19 changed files
with
602 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| generatorName: jetbrains-http-client | ||
| outputDir: samples/client/petstore/jetbrains/http/client | ||
| inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml | ||
| templateDir: modules/openapi-generator/src/main/resources/jetbrains-http-client | ||
| additionalProperties: | ||
| hideGenerationTimestamp: "true" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| --- | ||
| title: Documentation for the jetbrains-http-client Generator | ||
| --- | ||
|
|
||
| ## METADATA | ||
|
|
||
| | Property | Value | Notes | | ||
| | -------- | ----- | ----- | | ||
| | generator name | jetbrains-http-client | pass this to the generate command after -g | | ||
| | generator stability | EXPERIMENTAL | | | ||
| | generator type | CLIENT | | | ||
| | generator language | Jetbrains HTTP Client (HTTP/REST) | | | ||
| | generator default templating engine | mustache | | | ||
| | helpTxt | Generates a jetbrains-http client. See https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html | | | ||
|
|
||
| ## CONFIG OPTIONS | ||
| These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details. | ||
|
|
||
| | Option | Description | Values | Default | | ||
| | ------ | ----------- | ------ | ------- | | ||
| |allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false| | ||
| |disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true| | ||
| |ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true| | ||
| |enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false| | ||
| |legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl>|true| | ||
| |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false| | ||
| |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true| | ||
| |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true| | ||
|
|
||
| ## IMPORT MAPPING | ||
|
|
||
| | Type/Alias | Imports | | ||
| | ---------- | ------- | | ||
|
|
||
|
|
||
| ## INSTANTIATION TYPES | ||
|
|
||
| | Type/Alias | Instantiated By | | ||
| | ---------- | --------------- | | ||
|
|
||
|
|
||
| ## LANGUAGE PRIMITIVES | ||
|
|
||
| <ul class="column-ul"> | ||
| </ul> | ||
|
|
||
| ## RESERVED WORDS | ||
|
|
||
| <ul class="column-ul"> | ||
| </ul> | ||
|
|
||
| ## FEATURE SET | ||
|
|
||
|
|
||
| ### Client Modification Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |BasePath|✗|ToolingExtension | ||
| |Authorizations|✗|ToolingExtension | ||
| |UserAgent|✗|ToolingExtension | ||
| |MockServer|✗|ToolingExtension | ||
|
|
||
| ### Data Type Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |Custom|✗|OAS2,OAS3 | ||
| |Int32|✓|OAS2,OAS3 | ||
| |Int64|✓|OAS2,OAS3 | ||
| |Float|✓|OAS2,OAS3 | ||
| |Double|✓|OAS2,OAS3 | ||
| |Decimal|✓|ToolingExtension | ||
| |String|✓|OAS2,OAS3 | ||
| |Byte|✓|OAS2,OAS3 | ||
| |Binary|✓|OAS2,OAS3 | ||
| |Boolean|✓|OAS2,OAS3 | ||
| |Date|✓|OAS2,OAS3 | ||
| |DateTime|✓|OAS2,OAS3 | ||
| |Password|✓|OAS2,OAS3 | ||
| |File|✓|OAS2 | ||
| |Uuid|✗| | ||
| |Array|✓|OAS2,OAS3 | ||
| |Null|✗|OAS3 | ||
| |AnyType|✗|OAS2,OAS3 | ||
| |Object|✓|OAS2,OAS3 | ||
| |Maps|✓|ToolingExtension | ||
| |CollectionFormat|✓|OAS2 | ||
| |CollectionFormatMulti|✓|OAS2 | ||
| |Enum|✓|OAS2,OAS3 | ||
| |ArrayOfEnum|✓|ToolingExtension | ||
| |ArrayOfModel|✓|ToolingExtension | ||
| |ArrayOfCollectionOfPrimitives|✓|ToolingExtension | ||
| |ArrayOfCollectionOfModel|✓|ToolingExtension | ||
| |ArrayOfCollectionOfEnum|✓|ToolingExtension | ||
| |MapOfEnum|✓|ToolingExtension | ||
| |MapOfModel|✓|ToolingExtension | ||
| |MapOfCollectionOfPrimitives|✓|ToolingExtension | ||
| |MapOfCollectionOfModel|✓|ToolingExtension | ||
| |MapOfCollectionOfEnum|✓|ToolingExtension | ||
|
|
||
| ### Documentation Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |Readme|✗|ToolingExtension | ||
| |Model|✓|ToolingExtension | ||
| |Api|✓|ToolingExtension | ||
|
|
||
| ### Global Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |Host|✓|OAS2,OAS3 | ||
| |BasePath|✓|OAS2,OAS3 | ||
| |Info|✓|OAS2,OAS3 | ||
| |Schemes|✗|OAS2,OAS3 | ||
| |PartialSchemes|✓|OAS2,OAS3 | ||
| |Consumes|✓|OAS2 | ||
| |Produces|✓|OAS2 | ||
| |ExternalDocumentation|✓|OAS2,OAS3 | ||
| |Examples|✓|OAS2,OAS3 | ||
| |XMLStructureDefinitions|✗|OAS2,OAS3 | ||
| |MultiServer|✗|OAS3 | ||
| |ParameterizedServer|✗|OAS3 | ||
| |ParameterStyling|✗|OAS3 | ||
| |Callbacks|✓|OAS3 | ||
| |LinkObjects|✗|OAS3 | ||
|
|
||
| ### Parameter Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |Path|✓|OAS2,OAS3 | ||
| |Query|✓|OAS2,OAS3 | ||
| |Header|✓|OAS2,OAS3 | ||
| |Body|✓|OAS2 | ||
| |FormUnencoded|✓|OAS2 | ||
| |FormMultipart|✓|OAS2 | ||
| |Cookie|✓|OAS3 | ||
|
|
||
| ### Schema Support Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |Simple|✓|OAS2,OAS3 | ||
| |Composite|✓|OAS2,OAS3 | ||
| |Polymorphism|✓|OAS2,OAS3 | ||
| |Union|✗|OAS3 | ||
| |allOf|✗|OAS2,OAS3 | ||
| |anyOf|✗|OAS3 | ||
| |oneOf|✗|OAS3 | ||
| |not|✗|OAS3 | ||
|
|
||
| ### Security Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |BasicAuth|✓|OAS2,OAS3 | ||
| |ApiKey|✓|OAS2,OAS3 | ||
| |OpenIDConnect|✗|OAS3 | ||
| |BearerToken|✓|OAS3 | ||
| |OAuth2_Implicit|✓|OAS2,OAS3 | ||
| |OAuth2_Password|✓|OAS2,OAS3 | ||
| |OAuth2_ClientCredentials|✓|OAS2,OAS3 | ||
| |OAuth2_AuthorizationCode|✓|OAS2,OAS3 | ||
|
|
||
| ### Wire Format Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |JSON|✓|OAS2,OAS3 | ||
| |XML|✓|OAS2,OAS3 | ||
| |PROTOBUF|✗|ToolingExtension | ||
| |Custom|✗|OAS2,OAS3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
...or/src/main/java/org/openapitools/codegen/languages/JetbrainsHttpClientClientCodegen.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| package org.openapitools.codegen.languages; | ||
|
|
||
| import com.google.common.collect.ImmutableMap; | ||
| import com.samskivert.mustache.Mustache; | ||
| import com.samskivert.mustache.Template; | ||
| import org.openapitools.codegen.*; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.Writer; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.function.Function; | ||
| import java.util.function.Predicate; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import org.openapitools.codegen.meta.GeneratorMetadata; | ||
| import org.openapitools.codegen.meta.Stability; | ||
| import org.openapitools.codegen.model.ApiInfoMap; | ||
| import org.openapitools.codegen.model.ModelMap; | ||
| import org.openapitools.codegen.model.OperationMap; | ||
| import org.openapitools.codegen.model.OperationsMap; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class JetbrainsHttpClientClientCodegen extends DefaultCodegen implements CodegenConfig { | ||
| public static final String PROJECT_NAME = "Jetbrains HTTP Client"; | ||
|
|
||
| public CodegenType getTag() { | ||
| return CodegenType.CLIENT; | ||
| } | ||
|
|
||
| public String getName() { | ||
| return "jetbrains-http-client"; | ||
| } | ||
|
|
||
| public String getHelp() { | ||
| return "Generates a jetbrains-http client. See https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html"; | ||
| } | ||
|
|
||
| @Override | ||
| public GeneratorLanguage generatorLanguage() { | ||
| return GeneratorLanguage.HTTP; | ||
| } | ||
|
|
||
| public JetbrainsHttpClientClientCodegen() { | ||
| super(); | ||
|
|
||
| generatorMetadata = GeneratorMetadata.newBuilder(generatorMetadata) | ||
| .stability(Stability.EXPERIMENTAL) | ||
| .build(); | ||
|
|
||
| outputFolder = "generated-code" + File.separator + "jetbrains-http-client"; | ||
| apiTemplateFiles.put("api.mustache", ".http"); | ||
| embeddedTemplateDir = templateDir = "jetbrains-http-client"; | ||
| apiPackage = "Apis"; | ||
| supportingFiles.add(new SupportingFile("README.mustache", "", "README.md")); | ||
| } | ||
|
|
||
| @Override | ||
| protected ImmutableMap.Builder<String, Mustache.Lambda> addMustacheLambdas() { | ||
|
|
||
| return super.addMustacheLambdas() | ||
| .put("doubleMustache", new DoubleMustacheLambda()); | ||
| } | ||
|
|
||
| public static class DoubleMustacheLambda implements Mustache.Lambda { | ||
| @Override | ||
| public void execute(Template.Fragment fragment, Writer writer) throws IOException { | ||
| String text = fragment.execute(); | ||
| writer.write(text | ||
| .replaceAll("\\{", "{{") | ||
| .replaceAll("}", "}}") | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Map<String, Object> postProcessSupportingFileData(Map<String, Object> bundle) { | ||
|
|
||
| return bundle; | ||
| } | ||
|
|
||
| @Override | ||
| public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) { | ||
| return super.postProcessOperationsWithModels(objs, allModels); | ||
| } | ||
|
|
||
| @Override | ||
| public void postProcess() { | ||
| System.out.println("################################################################################"); | ||
| System.out.println("# Thanks for using OpenAPI Generator. #"); | ||
| System.out.println("# Please consider donation to help us maintain this project \uD83D\uDE4F #"); | ||
| System.out.println("# https://opencollective.com/openapi_generator/donate #"); | ||
| System.out.println("# #"); | ||
| System.out.println("# This generator was written by Julien Lengrand-Lambert (https://github.com/jlengrand) #"); | ||
| System.out.println("################################################################################"); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
modules/openapi-generator/src/main/resources/jetbrains-http-client/README.mustache
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # {{appName}} - Jetbrains API Client | ||
|
|
||
| ## OpenAPI File description | ||
|
|
||
| {{#appDescription}}{{appDescription}}{{/appDescription}} | ||
|
|
||
| * API basepath : [{{basePath}}]({{basePath}}) | ||
| * Version : {{version}} | ||
|
|
||
| ## Documentation for API Endpoints | ||
|
|
||
| {{#generateApiDocs}} | ||
| All URIs are relative to *{{{basePath}}}*, but will link to the `.http` file that contains the endpoint definition | ||
|
|
||
| Class | Method | HTTP request | Description | ||
| ------------ | ------------- | ------------- | ------------- | ||
| {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**](Apis/{{apiDocPath}}{{classname}}.http#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}} | ||
| {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} | ||
| {{/generateApiDocs}} | ||
|
|
||
|
|
||
| _This client was generated by the jetbrains-http-client of OpenAPI Generator_ |
11 changes: 11 additions & 0 deletions
11
modules/openapi-generator/src/main/resources/jetbrains-http-client/api.mustache
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ## {{classname}} | ||
| {{#operations}} | ||
| {{#operation}} | ||
|
|
||
| ### {{#summary}}{{summary}}{{/summary}} | ||
| # @name {{operationId}} | ||
| {{httpMethod}} {{basePath}}{{#lambda.doubleMustache}}{{path}}{{/lambda.doubleMustache}} | ||
| {{#consumes}}Content-Type: {{{mediaType}}} | ||
| {{/consumes}} | ||
| {{/operation}} | ||
| {{/operations}} |
29 changes: 29 additions & 0 deletions
29
...openapitools/codegen/jetbrains/http/client/JetbrainsHttpClientClientCodegenModelTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| package org.openapitools.codegen.jetbrains.http.client; | ||
|
|
||
| import org.openapitools.codegen.*; | ||
| import org.openapitools.codegen.languages.JetbrainsHttpClientClientCodegen; | ||
| import io.swagger.models.*; | ||
| import io.swagger.models.properties.*; | ||
|
|
||
| import org.testng.Assert; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| @SuppressWarnings("static-method") | ||
| public class JetbrainsHttpClientClientCodegenModelTest { | ||
|
|
||
| @Test(description = "convert a simple java model") | ||
| public void simpleModelTest() { | ||
| final Model model = new ModelImpl() | ||
| .description("a sample model") | ||
| .property("id", new LongProperty()) | ||
| .property("name", new StringProperty()) | ||
| .required("id") | ||
| .required("name"); | ||
| final DefaultCodegen codegen = new JetbrainsHttpClientClientCodegen(); | ||
|
|
||
| // TODO: Complete this test. | ||
| // Assert.fail("Not implemented."); | ||
| } | ||
|
|
||
| } | ||
|
|
19 changes: 19 additions & 0 deletions
19
.../org/openapitools/codegen/jetbrains/http/client/JetbrainsHttpClientClientCodegenTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| package org.openapitools.codegen.jetbrains.http.client; | ||
|
|
||
| import org.openapitools.codegen.*; | ||
| import org.openapitools.codegen.languages.JetbrainsHttpClientClientCodegen; | ||
| import io.swagger.models.*; | ||
| import io.swagger.parser.SwaggerParser; | ||
| import org.testng.Assert; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| public class JetbrainsHttpClientClientCodegenTest { | ||
|
|
||
| JetbrainsHttpClientClientCodegen codegen = new JetbrainsHttpClientClientCodegen(); | ||
|
|
||
| @Test | ||
| public void shouldSucceed() throws Exception { | ||
| // TODO: Complete this test. | ||
| // Assert.fail("Not implemented."); | ||
| } | ||
| } |
Oops, something went wrong.