Skip to content

Exposing Swagger File through Executor and providing Swagger UI through endpoint #1730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Apr 24, 2020
Merged

Exposing Swagger File through Executor and providing Swagger UI through endpoint #1730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
38f486c
Fixed file version path typo
axsaucedo Apr 6, 2020
47f4122
Merge remote-tracking branch 'upstream/master'
axsaucedo Apr 7, 2020
501834c
Merge remote-tracking branch 'upstream/master'
axsaucedo Apr 10, 2020
2fe81d0
Merge remote-tracking branch 'upstream/master'
axsaucedo Apr 14, 2020
caa1a3b
Merge remote-tracking branch 'upstream/master'
axsaucedo Apr 15, 2020
f9058ea
Merge remote-tracking branch 'upstream/master'
axsaucedo Apr 17, 2020
f6a984a
Merge remote-tracking branch 'upstream/master' into 1703_swagger_file
axsaucedo Apr 21, 2020
407781a
Added swagger file and ui
axsaucedo Apr 22, 2020
f041a44
Moved executor files to openapi folder
axsaucedo Apr 24, 2020
cf3d641
Moved swagger files in the correct location and added code to copy
axsaucedo Apr 24, 2020
1a0fd1e
renamed swaggerui
axsaucedo Apr 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion executor/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ executor
./bin/
cover.out
executor.tar

openapi/

2 changes: 2 additions & 0 deletions executor/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,7 @@ RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on go build -a -o executor
FROM gcr.io/distroless/static:latest
WORKDIR /
COPY --from=builder /workspace/executor .
# Copy openapi spec and swagger UI files
COPY openapi/ /openapi/
COPY licenses/license.txt .
ENTRYPOINT ["/executor"]
9 changes: 7 additions & 2 deletions executor/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,17 @@ add_protos:
test: fmt vet
go test ./api/... ./predictor/... ./k8s/... -coverprofile cover.out

copy-openapi-resources:
mkdir -p openapi/
cp ../openapi/swagger-ui/* openapi/
cp ../openapi/engine.oas3.json openapi/seldon.json

# Build the docker image
docker-build: test
docker-build: test copy-openapi-resources
docker build -f Dockerfile -t ${IMG} .

# Build the docker image for Redhat
docker-build-redhat: test
docker-build-redhat: test copy-openapi-resources
docker build . -f Dockerfile.redhat -t ${IMG_REDHAT}

# Push the docker image
Expand Down
2 changes: 2 additions & 0 deletions executor/api/rest/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,13 @@ func (r *SeldonRestApi) Initialise() {
api01.Handle("/predictions", r.wrapMetrics(metric.PredictionHttpServiceName, r.predictions))
r.Router.NewRoute().Path("/api/v0.1/status/{" + ModelHttpPathVariable + "}").Methods("GET").HandlerFunc(r.wrapMetrics(metric.StatusHttpServiceName, r.status))
r.Router.NewRoute().Path("/api/v0.1/metadata/{" + ModelHttpPathVariable + "}").Methods("GET").HandlerFunc(r.wrapMetrics(metric.StatusHttpServiceName, r.metadata))
r.Router.NewRoute().PathPrefix("/api/v0.1/doc/").Handler(http.StripPrefix("/api/v0.1/doc/", http.FileServer(http.Dir("./openapi/"))))
//v1.0 API
api1 := r.Router.PathPrefix("/api/v1.0").Methods("POST").Subrouter()
api1.Handle("/predictions", r.wrapMetrics(metric.PredictionServiceMetricName, r.predictions))
r.Router.NewRoute().Path("/api/v1.0/status/{" + ModelHttpPathVariable + "}").Methods("GET").HandlerFunc(r.wrapMetrics(metric.StatusHttpServiceName, r.status))
r.Router.NewRoute().Path("/api/v1.0/metadata/{" + ModelHttpPathVariable + "}").Methods("GET").HandlerFunc(r.wrapMetrics(metric.StatusHttpServiceName, r.metadata))
r.Router.NewRoute().PathPrefix("/api/v1.0/doc/").Handler(http.StripPrefix("/api/v1.0/doc/", http.FileServer(http.Dir("./openapi/"))))

case api.ProtocolTensorflow:
r.Router.NewRoute().Path("/v1/models/{" + ModelHttpPathVariable + "}/:predict").Methods("POST").HandlerFunc(r.wrapMetrics(metric.PredictionHttpServiceName, r.predictions))
Expand Down
58 changes: 58 additions & 0 deletions openapi/swagger-ui/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui.css" >
<style>
html
{
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}

*,
*:before,
*:after
{
box-sizing: inherit;
}

body
{
margin:0;
background: #fafafa;
}
</style>
</head>

<body>
<div id="swagger-ui"></div>

<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui-bundle.js"> </script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui-standalone-preset.js"> </script>
<script>
window.onload = function() {
// Begin Swagger UI call region
const ui = SwaggerUIBundle({
url: "./seldon.json",
dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})
// End Swagger UI call region

window.ui = ui
}
</script>
</body>
</html>
84 changes: 84 additions & 0 deletions openapi/swagger-ui/index_bundled.html
View file
Open in desktop

Large diffs are not rendered by default.