XML

​

Overview

• XML API endpoints
• SOAP compatibility
• Legacy system integration

​

Installation

import "github.com/go-mizu/mizu/middlewares/xml"

​

Quick Start

app := mizu.New()

app.Use(xml.New())

app.Get("/data", func(c *mizu.Ctx) error {
    return xml.Send(c, 200, data)
})

​

Examples

​

XML Response

type User struct {
    XMLName xml.Name `xml:"user"`
    ID      string   `xml:"id"`
    Name    string   `xml:"name"`
}

app.Get("/user/:id", func(c *mizu.Ctx) error {
    user := getUser(c.Param("id"))
    return xml.Send(c, 200, user)
})
// <user><id>1</id><name>John</name></user>

​

Parse XML Request

app.Post("/users", func(c *mizu.Ctx) error {
    var user User
    if err := xml.Bind(c, &user); err != nil {
        return err
    }
    // Process user
    return c.NoContent()
})

​

Content Negotiation

app.Use(xml.New())

app.Get("/data", func(c *mizu.Ctx) error {
    // Returns XML if Accept: application/xml
    // Returns JSON if Accept: application/json
    return c.Negotiate(200, data)
})

​

With Declaration

app.Get("/data", func(c *mizu.Ctx) error {
    return xml.SendWithDeclaration(c, 200, data)
})
// <?xml version="1.0" encoding="UTF-8"?><data>...</data>

​

API Reference

​

Functions

// New creates XML middleware
func New() mizu.Middleware

// Send sends XML response
func Send(c *mizu.Ctx, status int, data any) error

// SendWithDeclaration sends XML with declaration
func SendWithDeclaration(c *mizu.Ctx, status int, data any) error

// Bind parses XML request body
func Bind(c *mizu.Ctx, v any) error

​

Content Types

​

Technical Details

​

Architecture

• Context Keys: Uses private contextKey type to store body data, options, and preferred format
• Auto-Parsing: Optionally reads and caches XML request bodies for reusable access
• Content Negotiation: Detects client preferences via Accept header and stores format preference

​

Implementation Details

• Indent: Indentation string for pretty printing (default: empty)
• Prefix: Prefix for each XML element (default: empty)
• ContentType: Content type for responses (default: “application/xml”)
• AutoParse: Automatically parse XML request bodies (default: false)
• XMLDeclaration: Include XML declaration in responses (default: true)

• Standard marshaling: Uses xml.Marshal
• Pretty printing: Uses xml.MarshalIndent with configurable indent and prefix

​

Response Flow

1. Middleware checks Accept header for XML compatibility
2. If AutoParse enabled, reads and caches request body
3. Stores options in context for response functions
4. Response functions retrieve options from context
5. Marshal data with appropriate settings
6. Set Content-Type header with charset
7. Write XML declaration (if enabled) and data

​

Best Practices

• Use proper struct tags
• Handle encoding correctly
• Validate XML input
• Consider namespace handling
• Enable AutoParse when binding XML requests frequently
• Use Pretty() middleware during development for readable output

​

Testing

​

Related Middlewares

• contenttype - Content-Type validation
• msgpack - MessagePack handling
• validator - Input validation