go/mailpit
1
0
Fork 0
mirror of https://github.com/axllent/mailpit.git synced 2025-07-17 01:32:33 +02:00
Code Issues Releases Activity

Chore: Add swagger examples & API code restructure

Browse Source
This commit is contained in:
Ralph Slooten
2024-11-09 12:33:16 +13:00
parent 8f79fcd0d5
commit 657cada916
16 changed files with 1480 additions and 1345 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
server/apiv1/send.go
View File

@ -17,7 +17,7 @@ import (
"github.com/jhillyerd/enmime"
)
// swagger:parameters SendMessage
// swagger:parameters SendMessageParams
type sendMessageParams struct {
// in: body
Body *SendRequest
@ -108,13 +108,6 @@ type SendRequest struct {
Headers map[string]string
}
// SendMessageConfirmation struct
type SendMessageConfirmation struct {
// Database ID
// example: iAfZVVe2UQFNSG5BAjgYwa
ID string
}
// JSONErrorMessage struct
type JSONErrorMessage struct {
// Error message
@ -122,25 +115,41 @@ type JSONErrorMessage struct {
Error string
}
// Confirmation message for HTTP send API
// swagger:response sendMessageResponse
type sendMessageResponse struct {
// Response for sending messages via the HTTP API
//
// in: body
Body SendMessageConfirmation
}
// SendMessageConfirmation struct
type SendMessageConfirmation struct {
// Database ID
// example: iAfZVVe2UQfNSG5BAjgYwa
ID string
}
// SendMessageHandler handles HTTP requests to send a new message
func SendMessageHandler(w http.ResponseWriter, r *http.Request) {
// swagger:route POST /api/v1/send message SendMessage
// swagger:route POST /api/v1/send message SendMessageParams
//
// # Send a message
//
// Send a message via the HTTP API.
//
// Consumes:
// - application/json
// - application/json
//
// Produces:
// - application/json
// - application/json
//
// Schemes: http, https
//
// Responses:
// 200: sendMessageResponse
// default: jsonErrorResponse
// 200: sendMessageResponse
// 400: jsonErrorResponse
if config.DemoMode {
httpJSONError(w, "this functionality has been disabled for demonstration purposes")