idea Support Swagger for ArcGIS Server REST endpoints in ArcGIS Enterprise Ideas

Support Swagger for ArcGIS Server REST endpoints

DaveTimmins — Thu, 28 Feb 2013 02:14:02 GMT

The current REST API endpoints for the ArcGIS server services directory and administration allow you to get some useful information and test operations but the documentation is very basic and when complex inputs are required there is no help at all really. By adding Swagger support you could provide the user with a much richer experience and make the API more self documenting.

Re: Support Swagger for ArcGIS Server REST endpoints

DavidSmith21 — Mon, 21 Nov 2016 16:39:22 GMT

Swagger/RAML support would be very useful for enterprise API management frameworks. It would also be useful for registering services in catalogs like api.data.gov

Re: Support Swagger for ArcGIS Server REST endpoints

AndrewRay1 — Mon, 27 Feb 2017 21:33:13 GMT

Most repositories for mapping api functionality these days seem to support import from Swagger and there are even libraries in popular languages that can help "wrap" an API that exposes swagger to make development easier. this would be a huge benefit to adoption of the REST Endpoints (and in turn the arcgis stack)

Re: Support Swagger for ArcGIS Server REST endpoints

JohnDye — Fri, 06 Oct 2017 14:27:57 GMT

Word. This would be awesome!

Re: Support Swagger for ArcGIS Server REST endpoints

AndrewRay1 — Fri, 03 Nov 2017 18:49:27 GMT

Note this has been adapted as the "standard" for Open API Initiative. that should add a bit more incentive to become a "partner" in the API space.

Re: Support Swagger for ArcGIS Server REST endpoints

BrianHennessey1 — Fri, 21 Dec 2018 16:52:25 GMT

It's criminal that this doesn't exist. Get with the program ESRI.

Re: Support Swagger for ArcGIS Server REST endpoints

ZacharyStauber1 — Mon, 19 Aug 2019 16:56:52 GMT

We're now going all-hands-on-deck to get everything we have into an API management platform, and the idea of creating an OpenAPI/Swagger file for every one of our services is a nonstarter. Esri, please do this.

Re: Support Swagger for ArcGIS Server REST endpoints

SamuelValdez — Tue, 21 Apr 2020 01:15:03 GMT

Was this idea really created way back in 2013? Well, then I might as well jump on the bandwagon! I was really hoping to ask about this at this year's (2020) Developer Summit but based upon Esri's response to this idea, it does not seem to be a priority for them. I found agol-swagger online but it is about four years old, and it is not comprehensive.

We have an internal use case that I want to explore, and I feel pretty confident about getting a tiny piece of this to work with WSO2. Does anyone have any advice or experience to share? If I am successful, then I may try to share that here.

Thank you!

Re: Support Swagger for ArcGIS Server REST endpoints

roemhildtg — Thu, 11 Jun 2020 15:47:08 GMT

I would also add that swagger API for portal/AGO rest services would be handy as well.

Re: Support Swagger for ArcGIS Server REST endpoints

John-Waterman — Wed, 16 Dec 2020 13:56:25 GMT

Need ArcGIS Swagger definition for AWS API Gateway. Thanks!

Re: Support Swagger for ArcGIS Server REST endpoints

Anonymous User — Wed, 27 Jan 2021 19:37:06 GMT

Yes please swagger support for ArcGIS enterprise

Re: Support Swagger for ArcGIS Server REST endpoints

JenniferLang — Thu, 04 Feb 2021 23:02:52 GMT

It seems like many other APIs have a swagger page. Why hasn't ESRI followed industry best practice. I'd love to learn how it use it better and I find I learn better if I'm doing rather than reading pages and pages of documentation.

Re: Support Swagger for ArcGIS Server REST endpoints

RPW — Mon, 06 Sep 2021 08:58:35 GMT

We also require Swagger / Open API support for our ArcGIS Server REST endpoints to register our web services with Azure API Management and data catalogues. Currently, we need to create Swagger files manually, and are considering developing a tool that could automate this process. However, it would be much easier if ArcGIS Server supported the Open API standard by default. I understand that GeoEvent Server supports Swagger, so there seems to be partial Esri support for it.

If anyone has tips or more information, it would be highly appreciated.

Re: Support Swagger for ArcGIS Server REST endpoints

LaurensKusse_hhdelfland — Mon, 24 Jun 2024 14:28:32 GMT

I thought Esri finally solved this issue by implementing OGC feature service.

I tested this service-type (with ArcGIS Enterprise 11.3) and it does provide a json that says "openapi": "3.0.3" and a html that says:

The API document provides a machine processable description of this service API conformant to api 3.

Unfortunately it still is not OpenAPI compliant. So you can't import it into Swagger or Azure APIM.

Support told me this request is accepted for one of the coming releases: ENH-000122818: Request to support an OpenAPI specification with the ArcGIS REST API (I can't find this enhancement myself. Maybe I don't have access)

If anyone has tips or tricks how to create a correct json, from the OGC Feature-service-json, that would be appreciated.

I tried comparing with OGC feature services with a correct OpenAPI specification, that I found over here: https://api.hamburg.de/datasets/v1

But I'm not yet successful.

Re: Support Swagger for ArcGIS Server REST endpoints

LaurensKusse_hhdelfland — Thu, 18 Jul 2024 11:29:30 GMT

I managed to alter the json that the Esri OGC Feature-service provides. Now I can import the json into Swagger or Azure APIM without errors. It works, but I'm not sure if all the parameters are correct.

The main issue was that the json contains references without the item that it refers to. So that is what I added. Azure APIM also didn't agree with the 200 response. So I changed that too.

replace this:

"schemas": {}

with this:

"parameters": { "f": { "in": "query", "name": "Whatever name you like", "schema": {"type": "string"} } }, "schemas": { "LandingPage": { }, "Conformance": { }, "Collections": { } , "collectionInfo": { }, "htmlSchema": { "type": "string", "example": "<html>...</html>" } }

And this:

"200": { "description": "successful operation", "$ref": "#/components/schemas/LandingPage" }

with this:

"200": { "description": "The operation was executed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LandingPage" } }, "text/html": { "schema": { "$ref": "#/components/schemas/htmlSchema" } } } }, "400": { "description": "Bad Request" }, "406": { "description": "Not Acceptable" }, "500": { "description": "Server Error" }

Re: Support Swagger for ArcGIS Server REST endpoints

JoshuaBixby — Mon, 28 Jul 2025 20:22:25 GMT

Twelve years and still waiting.... I would say still hoping, but I think I have given up hope. The need for this has been covered by earlier comments, so I won't repeat them again.