Add detail on creating endpoints

[alansill]

I managed to get this to install by cloning the repository to my $GOPATH/src, running "dep ensure -v" and figuring out where the latest scoop.yaml file is in the latest release (links are broken in the instructions for this and a few other things). I have everything started in my kubernetes instance and the right results showing up as the results of a kubectl get all -n gloo-system command.

Rather than start the petstore example, I'd like to deploy sqoop for a REST test service of my own that has an OpenAPI description available. I can even deploy it as a GraphQL endpoint if needed, but would like to start with an example of using sqoop with an OpenAPI endpoint on my own.

Any pointers to reading to get started? The main point is that eventually it would be good to show people how to get past the bundled petstore example.

[ilackarms]

@alansill sorry you had so much trouble getting sqoop and running!

the tutorial provided will work with any REST app with an OpenAPI Spec. the key is that discovery needs to pick up the swagger spec off of a common endpoint. i don't recall all the endpoints discovery currently tries, but i'm sure /swagger.json works if you are able to serve the spec from that location.

try deploying your app with the /swagger.json endpoint and run glooctl get upstreams

you should see that the REST functions were discovered and are listed on the upstream

once that's done, you'll need to create a GraphQL schema that represents the data types your REST app.

upload the schema using sqoopctl create schema .... sqoop will then create a ResolverMap for the schema.

once the resolvermap is created, register the fields from your schema to the REST functions you'd like Sqoop to map them to via

sqoopctl resolvermap register -u <upstream-name> -s <schema-name> -g <function-name> <Schema Type> <Schema Field>

[alansill]

Thanks! This is helpful.

In cases in which the services being proxied are not running in k8s, but are provided as external OpenAPI REST services, is there a way to do that (preferably being able to provide the OpenAPI yaml or json description file spearately, out of band from the service itself)? Also, is OpenAPIv3 supported for discovery? A few more links would be helpful.