OpenAPITools / OpenAPITools/openapi-generator

[REQ] Add generator for Apigee Edge Policy Bundles

Open
#1,940 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature Enhancement: New generator Hacktoberfest help wanted
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

I would like to use OpenAPI 3.0 instead of 2.0.
I want to use Apigee edge as my API proxy, but Apigee only supports creating proxies based on 2.0.
Luckily server stub and client sdk is good enough with 3.0, so that leaves getting the proxy as my last hurdle to using 3.0.

Describe the solution you'd like

OpenAPI-generator could generate Apigee policy bundles similar to openapi2apigee.
https://github.com/anil614sagar/openapi2apigee
(Sadly that project hasn't been maintained for 2-3 years, and, since 3.0 was released 1.5 years go, it can't have support for 3.0 specs).

Describe alternatives you've considered

Apigee has been saying 3.0 support "is coming" in their support forum since before 3.0 was released.
I've also looked at other tools like openapi2apigee.

Additional context

In the end, the apigee APIs for creating/updating proxies expect a Policy Bundle (a zipped up copy of xml files). So, it might be a possibility to use a generator like openapi-generator to create that bundle.

docs on building proxies
upload proxy bundle api
update proxy revision api with new bundle
get proxy bundle api

docs on proxy bundle samples
list of available bundle samples
the sample proxy bundles on github

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the openapi2apigee project and the linked Apigee documentation on proxy bundles, samples, and bundle APIs. Determine how an OpenAPI 3.0 document should map to the required zipped XML policy bundle. Done means producing a bundle that Apigee accepts for proxy creation or revision updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.