Skip to main content

openapi_nexus/generators/go/http/
codegen.rs

1//! Go HTTP code generator: IR + sigil-stitch.
2//!
3//! Receives a lowered `IrSpec` and emits:
4//! 1. Models via `sigil_emit::generate_model_files`.
5//! 2. APIs via `sigil_emit_api::generate_api_files`.
6//! 3. Hardcoded runtime (`client.go`, `auth.go`, `errors.go`).
7//! 4. `go.mod` and `README.md`.
8
9use std::error::Error;
10
11use heck::ToKebabCase as _;
12
13use super::config::GoHttpConfig;
14use super::runtime::runtime_files;
15use super::{sigil_emit, sigil_emit_api};
16use crate::codegen::traits::code_generator::CodeGenerator;
17use crate::codegen::traits::file_writer::{FileInfo, FileWriter};
18use crate::codegen::{GeneratorType, Language};
19use crate::generators::request_inputs::plan_multipart_request_inputs;
20use crate::ir::types::{IrInfo, IrSpec};
21
22const DEFAULT_MODULE_PATH: &str = "example.com/sdk";
23
24/// Go HTTP code generator.
25#[derive(Debug, Clone)]
26pub struct GoHttpCodeGenerator {
27    config: GoHttpConfig,
28}
29
30impl GoHttpCodeGenerator {
31    /// Create a new Go HTTP generator from a TOML config fragment.
32    pub fn new(config: toml::value::Table) -> Self {
33        Self {
34            config: GoHttpConfig::from(config),
35        }
36    }
37
38    fn module_path(&self) -> String {
39        self.config
40            .module_path
41            .clone()
42            .unwrap_or_else(|| DEFAULT_MODULE_PATH.to_string())
43    }
44
45    /// Orchestrate emission from the lowered IR.
46    fn generate_ir(&self, ir: &IrSpec) -> Result<Vec<FileInfo>, Box<dyn Error + Send + Sync>> {
47        let module_path = self.module_path();
48        let header = render_file_header(&ir.info);
49        let request_inputs = plan_multipart_request_inputs(ir);
50
51        let mut files = Vec::new();
52
53        // Models
54        files.extend(
55            sigil_emit::generate_model_files(ir, &module_path, &header, &request_inputs).map_err(
56                |msg| Box::<dyn Error + Send + Sync>::from(format!("sigil_emit models: {msg}")),
57            )?,
58        );
59
60        // APIs
61        files.extend(
62            sigil_emit_api::generate_api_files(ir, &module_path, &header, &request_inputs)
63                .map_err(|msg| {
64                    Box::<dyn Error + Send + Sync>::from(format!("sigil_emit_api: {msg}"))
65                })?,
66        );
67
68        // Runtime (hardcoded)
69        files.extend(runtime_files(&header, request_inputs.has_uploads()));
70
71        // Project files: go.mod, README.md
72        files.push(go_mod_file(&module_path));
73        files.push(readme_file(&ir.info));
74
75        Ok(files)
76    }
77}
78
79impl CodeGenerator for GoHttpCodeGenerator {
80    fn language(&self) -> Language {
81        Language::Go
82    }
83
84    fn generator_type(&self) -> GeneratorType {
85        GeneratorType::GoHttp
86    }
87
88    fn generate(&self, ir: &IrSpec) -> Result<Vec<FileInfo>, Box<dyn Error + Send + Sync>> {
89        self.generate_ir(ir)
90    }
91}
92
93impl FileWriter for GoHttpCodeGenerator {}
94
95fn render_file_header(info: &IrInfo) -> String {
96    let mut out = String::new();
97    out.push_str("// Code generated by openapi-nexus. DO NOT EDIT.\n");
98    out.push_str("//\n");
99    out.push_str(&format!("// {} — {}\n", info.title, info.version));
100    if let Some(desc) = &info.description {
101        for line in desc.lines() {
102            out.push_str(&format!("// {line}\n"));
103        }
104    }
105    out.push('\n');
106    out
107}
108
109fn go_mod_file(module_path: &str) -> FileInfo {
110    let content = format!("module {module_path}\n\ngo 1.21\n");
111    FileInfo::project("go.mod".to_string(), content)
112}
113
114fn readme_file(info: &IrInfo) -> FileInfo {
115    let title = &info.title;
116    let version = &info.version;
117    let description = info
118        .description
119        .clone()
120        .unwrap_or_else(|| "Generated Go SDK.".to_string());
121    let package = info.title.to_kebab_case();
122    let content = format!(
123        "# {title}\n\n{description}\n\nVersion: `{version}`\n\nGenerated by [openapi-nexus](https://github.com/rust-codegen-group/openapi-nexus) for `{package}`.\n"
124    );
125    FileInfo::readme("README.md".to_string(), content)
126}