How can I import and compose @routes ?

[laduke]

I can import and use models.
But I can't figure out how to put http/rest stuff in different files and then compose them into one big root /api.
If the answer is "don't do that", that's fine too.

something like this to demo what I mean:

import "@typespec/openapi";
import "@typespec/http";

using TypeSpec.Http;
using TypeSpec.OpenAPI;

@service({
  title: "Animal  API",
})
namespace Root {

  //...Cat
  //...Dog

}

// from a cat file
@tag("Cat")
@route("/cat")
namespace Cat {
  @get
  @summary("Cat Status")
  op get(): "Cat";
}

// from a dog file
@tag("Dog")
@route("/dog")
namespace Dog {
  @get
  @summary("Dog Status")
  op get(): "Dog";

  @list
  @summary("Dog List")
  op list(): "Dogs";
}

[bterlson]

I think that should work fine, you just need to ensure Dog and Cat namespaces are within the Root namespace. Since each file's global scope is the global namespace, you need to be explicit, either by putting namespace Root; near the top, nesting Dog and Cat namespace declarations inside namespace Root { }, or using dotted identifiers like namespace Root.Dog { }.

[laduke]

Thanks for replying. I think I see what you mean. I was trying to go about it backwards. That works, but my example didn't explain enough.

I wanted to have a main file with a /some/api/base and then push /dog and /cat onto there.

The way to compiler is merging the namespaces means the sub-routes need to know the shape of main. I think.

[bterlson]

By "know the shape of main", do you mean the existence of the root namespace? In other words, you want dog and cat to be placed in an arbitrary root namespace? If so, you could define Dog and Cat as interfaces instead and use interface extends in your main.tsp, but you would have to be explicit about the route of that namespace. Something like:

import "./Cat.tsp";
@service({
  title: "Animal  API",
})
namespace Root;

@route("/cat")
interface RootCat extends Cat { }

[laduke]

sorry for not explaining well. This does what I want, if a little awkwardly

import "@typespec/openapi";
import "@typespec/http";

using TypeSpec.Http;
using TypeSpec.OpenAPI;

interface Cat {
    @get
    @summary("Cat Status")
    get(): string;
}

interface Dog {
    @get
    @summary("Dog Status")
    op get(): "Dog";
}

@service({
    title: "Animal  API",
})
@server("http:/example/api/animal", "Central API")
namespace Animals {
    @tag("mammal")
    @route("/mammal")
    namespace mammal {
        @get
        op get(): string[];

        @route("/dog")
        interface _Dog extends Dog {}

        @route("/cat")
        interface _Cat extends Cat {}
    }

    // if for some reason you need the same interface at two different paths
    @route("/dog")
    interface _Dog extends Dog {}
}

openapi: 3.0.0
info:
  title: Animal  API
  version: 0.0.0
tags:
  - name: mammal
paths:
  /dog:
    get:
      operationId: _Dog_get
      summary: Dog Status
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Dog
  /mammal:
    get:
      tags:
        - mammal
      operationId: mammal_get
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
  /mammal/cat:
    get:
      tags:
        - mammal
      operationId: _Cat_get
      summary: Cat Status
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                type: string
  /mammal/dog:
    get:
      tags:
        - mammal
      operationId: _Dog_get
      summary: Dog Status
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Dog
components: {}
servers:
  - url: http:/example/api/animal
    description: Central API
    variables: {}