Only flat service with group? Anyway to generate more hierarchical service? Or any other suggestion?

[CroMarmot]

I'm using fastapi as my backend, I'm writing self-hosted code for personal using. Collect some food, music, book, game...

an example code is

main.py

import logging
from pydantic import BaseModel
from fastapi import FastAPI, APIRouter
from fastapi.routing import APIRoute
from .book_router import book_router
from .game_router import game_router

def custom_generate_unique_id(route: APIRoute) -> str:
    return "-".join([str(tag) for tag in route.tags] + [route.name])


app = FastAPI(generate_unique_id_function=custom_generate_unique_id)

app.include_router(book_router, prefix="/book", tags=["book"])
app.include_router(game_router, prefix="/game", tags=["game"])

game_router.py

import logging
from pydantic import BaseModel
from fastapi import FastAPI, APIRouter

game_router = APIRouter()

class GameUpsertReq(BaseModel):
    game_name: str

@game_router.post("/up")
def upsert(req: GameUpsertReq) -> str:
    logging.info(f"game:{req=}")
    return ""

book_router.py

from pydantic import BaseModel
from fastapi import FastAPI, APIRouter
from .book_tags_router import tags_router

book_router = APIRouter()

class BookUpsertReq(BaseModel):
    book_name: str

@book_router.post("/up")
def upsert(req: BookUpsertReq) -> str:
    logging.info(f"book:{req=}")
    return ""

book_router.include_router(tags_router, prefix="/tags", tags=["tags"])

book_tags_router.py

import logging
from pydantic import BaseModel
from fastapi import FastAPI, APIRouter

tags_router = APIRouter()

class TagsUpsertReq(BaseModel):
    tags_name: str

@tags_router.post("/up")
def upsert(req: TagsUpsertReq) -> str:
    logging.info(f"tags:{req=}")
    return ""

---

https://swagger.io/specification/ says: A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

I want

• GameService,BookService,BookTagsService

or

• GameService,BookService(with TagsService inside)

anyway to make this happen

---

I've read the code

openapi-ts/packages/openapi-ts/src/openApi/v3/parser/getServices.ts

Lines 60 to 69 in df9c928

	tags.forEach((tag) => {
	const operation = getOperation({
	method,
	op,
	openApi,
	pathParams: pathParameters,
	tag,
	types,
	url,
	});

The code treats all tags as the same level of non-sequential order.

But this make me feel confused, I write backend code hierarchical but generate frontend code flat (only have group).

Or any other suggestion?

[mrlubos]

@CroMarmot Does services.asClass: true do what you'd expect?

[CroMarmot]

@mrlubos No, I add that beforce, I've also found methodNameBuilder before

openapi-ts.config.ts

import { defineConfig } from '@hey-api/openapi-ts';

export default defineConfig({
  client:'angular',
  services: {
    asClass: true,
    methodNameBuilder: (operation: any) => {
      console.log(operation);
      return operation.name;
    },
  },
});

these only have group, but not nested

---

Example:

backend tags python:

- A func0,func1
- B func2
  - C func3,func4
     - D func5

frontend generate(what i got now):

A: func0,func1
B: func2 func3 func4 func5
C: func3 func4 func5
D: func5

i expected:

A: func0,func1
B: func2
BC: func3,func4
BCD: func5

or

A: func0,func1
B: func2
 - C: func3,func4
   - D: func5

---

I checked openapi.json, there have exist enough info for generate what i want

    "/api/bbbbbbb/ccccccc/funcccc3": {
      "post": {
        "tags": [
          "b",
          "c"
        ],
        "summary": "Func3",
        "operationId": "b-c-func3",