Altinn / altinn-access-management

PoC for new auth admin UI
MIT License
6 stars 3 forks source link

Forbedre generert OpenAPI spec #679

Open jonkjetiloye opened 6 months ago

jonkjetiloye commented 6 months ago

For å enklere kunne publisere API swagger dokumentasjon for våre APIer til Studio Docs trenger vi en måte å splitte/knytte de forskjellige APIene våre til forskjellige docs.

F.eks noe ala:

services.AddSwaggerGen(options =>
{
    // All Access Management API Doc
    options.SwaggerDoc("All", new OpenApiInfo { Title = "All Access Management Api Endpoints (for APIM deploy)", Version = "v1" });

    // Internal Platform API Doc
    options.SwaggerDoc("Internal", new OpenApiInfo { Title = "Access Management Internal Platform Api", Version = "v1" });

    // External Resource Owner API Doc
    options.SwaggerDoc("ResourceOwner", new OpenApiInfo { Title = "Access Management Resource Owner Api", Version = "v1" });

    // External Enduser System API Doc
    options.SwaggerDoc("EnduserSystem", new OpenApiInfo { Title = "Access Management Enduser System Api", Version = "v1" });

    options.AddSecurityDefinition("OAuth2", new OpenApiSecurityScheme
    {
        Name = "Authorization",
        Description = "Standard Authorization header using the Bearer scheme. Example: \"bearer {token}\"",
        In = ParameterLocation.Header,
        Type = SecuritySchemeType.OAuth2
    });
    options.OperationFilter<SecurityRequirementsOperationFilter>();
});

Slik at vi kan skille på Interne API Tjenesteeier API Sluttbruker/Sluttbruker-system API (er her vår BFF også er konsument)

Inntil videre så lenge APIM deployen er det den der må vi i tillegg en felles fil som inneholder alt. Som vi må finne en løsning på mulig vi må lage eller finne andre eksisterende merge tools vi kan bruke.

Det nye Platform teamet er i ferd med å starte arbeid for å forbedre APIM. Så vi bør absolutt prøve å henge oss på planene der å opptre som en kravstiller inn til det arbeidet.

Men i første om gang gjelder denne oppgaven som hvordan vi kan få:

Herskis commented 1 month ago

@tjololo Tar en prat med @jonkjetiloye så vi er samkjørte om veien framover