IApiReferenceExporter
Interfacenet10.0
Optional companion to
ICodeGenerator for languages that can describe their generated surface as a machine-readable API reference. namespace Aspire.TypeSystem;
public interface IApiReferenceExporter{ // ...}Remarks
Section titled Remarks Code generation and API export answer different questions. ICodeGenerator produces the source a user compiles against; this interface produces the documentation model that describes that source. Keeping them separate means a language provider can ship runnable code generation long before it can describe it, and documentation tooling can tell the difference instead of publishing a silently empty reference.
The payload schema is owned by the language provider. Hosts must pass the returned document through unmodified so language-specific details survive transport.
Properties1
Section titled Propertiesstring Gets the target language name (for example, "TypeScript"). This must match the
ICodeGenerator.Language value of the generator that produces the same surface, so a host can resolve one from the other. Methods1
Section titled MethodsJsonElement Exports the API reference for the surface the generator would produce from the same context.
Aspire