docs.intersystems.com
InterSystems IRIS Data Platform 2019.2

Creating REST Services
Next section
InterSystems: The power behind what matters   
Search:  


Preface : 
 
Chapter 1: 
 
1.1 Introduction to REST
1.2 Introduction to InterSystems REST Services
1.3 Introduction to InterSystems API Management Tools
1.4 Overview of Creating REST Services
1.5 A Closer Look at the REST Service Classes
1.6 Enabling Logging for API Management Features
Chapter 2: 
 
2.1 Using the /api/mgmnt Service to Create a REST Service
2.2 Using the /api/mgmnt Service to Update a REST Service
2.3 Using the /api/mgmnt Service to Delete a REST Service
Chapter 3: 
 
3.1 Using the ^%REST Routine
3.2 Using the ^%REST Routine to Create a REST Service
3.3 Using the ^%REST Routine to Delete a REST Service
Chapter 4: 
 
4.1 Using the %REST.API Class to Create or Update a REST Service
4.2 Using the %REST.API Class to Delete a REST Service
Chapter 5: 
 
5.1 Initial Method Definitions
5.2 Implementing the Methods
5.3 Exposing Details of Server Errors
5.4 Modifying the Error Response
Chapter 6: 
 
6.1 Overview
6.2 Overriding the Content Type, Response Character Set, or Input Stream Handling
6.3 Overriding the Name of a Service Method
Chapter 7: 
 
7.1 Overview
7.2 Accepting the CORS Header
7.3 Defining How to Process the CORS Header
Chapter 8: 
 
8.1 Introduction
8.2 Enabling a REST Service to Use Web Sessions
Chapter 9: 
 
9.1 Setting Up Authentication for REST Services
9.2 Specifying Privileges Needed to Use REST Services
Chapter 10: 
 
10.1 Using the /api/mgmnt Service to Discover REST Services
10.2 Using the %REST.API Class to Discover REST Services
10.3 Providing Documentation for a REST Service
Reference A: 
 
DELETE /api/mgmnt/v2/:namespace/:application/ — Deletes the classes for the given REST application. Note that this call looks for a newer REST service. It ignores any manually-coded REST services.
GET /api/mgmnt/ — Returns an array that contains information about REST-enabled web applications in all namespaces.
GET /api/mgmnt/v1/:namespace/restapps — Returns an array that contains information about REST-enabled web applications in the given namespace.
GET /api/mgmnt/v1/:namespace/spec/:application/ — Returns the OpenAPI 2.0 specification for the given REST service, which must be a manually-coded REST service.
GET /api/mgmnt/v2/ — Returns an array that contains information about the newer REST services on the server (including any that do not have an associated web application). This call ignores any manually-coded REST services.
GET /api/mgmnt/v2/:namespace/ — Returns an array that contains information about the newer REST services in the given namespace (including any REST services that do not have an associated web application). This call ignores any manually-coded REST services.
GET /api/mgmnt/v2/:namespace/:application/ — Returns the OpenAPI 2.0 specification for the given REST service. The REST service can be either a newer REST service or a manually-coded REST service.
POST /api/mgmnt/v2/:namespace/:application/ — Given a Swagger (OpenAPI 2.0) specification, this call generates the scaffolding for the REST application.
Appendix A: 
 
A.1 Swagger
A.2 Info Object
A.3 Path Item Object
A.4 Operation Object
A.5 Parameter Object
A.6 Items Object
Appendix B: 
 
B.1 Basics of Creating a REST Service Manually
B.2 Creating the URL Map
B.3 Specifying the Data Format
B.4 Localizing a REST Service
B.5 Using Web Sessions with REST
B.6 Supporting CORS
B.7 Variation: Accessing Query Parameters


Next section
Send us comments on this page
View this book as PDF   |  Download all PDFs
Copyright © 1997-2019 InterSystems Corporation, Cambridge, MA
Content Date/Time: 2019-08-22 06:48:58