Nested REST API

Question

I'm trying to implement endpoint hierarchy in one class. I want to make something like this:

@RestResource(urlMapping = '/endpoint')
global with sharing class Class1{

    @HTTPGet
    global static void methodForGet(){
    }

    @RestResource(urlMapping = '/endpoint/v1')
    global with sharing class Class2{

        @HTTPGet
        global static void methodForGet(){
        }
}

Will SF let me do something like that and how it should be implemented?

Answer 1

@RestResource must be declared on a top-level class. If you want different versions to co-exist in the same class, you can write a router.

@RestResource(urlMapping='/endpoint/*')
global class EndpointHandler {
    @HttpGet global static void doGet() {
        if(RestContext.request.requestURI.endsWith('endpoint')) {
          // call "version 0"
        } else if(RestContext.request.requestURI.endsWith('v1')) {
          // call "version 1"
        } else if...

Typically, you'll probably want to instead keep each version in a separate top-level class, and write a utility class to avoid code duplication.

Answer 2

You are going to need a separate top-level Class for each endpoint you want to expose as an @RestResource. I'm going to recommend that you manage versions in the same way. That way v1/endpoint and v2/endpoint can live side by side without a mandatory hard cut-over date.