swiftapi

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 29, 2025 License: MIT Imports: 6 Imported by: 0

README

🚀 SwiftAPI - Next-Generation API Framework for Go

Go Version

SwiftAPI redefines API development in Go with its intuitive design and powerful feature set, engineered for modern web applications requiring speed, safety, and scalability.

📦 Installation

go get github.com/AbrahamBass/swiftapi@latest

🌟 Why Choose SwiftAPI?

  • Zero-Config Productivity – Start building immediately with sensible defaults
  • Enterprise-Grade Features – Built-in security, real-time capabilities, and robust error handling
  • Future-Ready Architecture – Modular design that grows with your application needs

🚧 Project Status

  • ✅ Production Ready – Actively maintained with regular updates
  • 🔭 Upcoming Features – See roadmap below for planned enhancements

📚 Documentation Preview

Complete documentation is currently in development and will include:

  • Quickstart guides for various use cases
  • Deep dives into advanced features
  • Security best practices
  • Performance optimization techniques
  • Migration guides from other frameworks

📢 Watch releases to be notified when documentation becomes available.

🤝 Contributing

We welcome community involvement through:

  • Feature suggestions
  • Bug reports
  • Documentation improvements
  • Security audits

Before contributing:

  • Check open issues for existing discussions

✅ This Version Positions SwiftAPI As:

  • ✅ Professional
  • ✅ Ambitious
  • ✅ Community-oriented
  • ✅ Production-ready

Perfect for attracting early adopters while finalizing documentation! 🚀

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Response = responses.Response

	Ok                  = responses.Ok
	Created             = responses.Created
	Accepted            = responses.Accepted
	NoContent           = responses.NoContent
	MovedPermanently    = responses.MovedPermanently
	Found               = responses.Found
	NotModified         = responses.NotModified
	NotFound            = responses.NotFound
	BadRequest          = responses.BadRequest
	Unauthorized        = responses.Unauthorized
	Forbidden           = responses.Forbidden
	Conflict            = responses.Conflict
	UnprocessableEntity = responses.UnprocessableEntity
	InternalServerError = responses.InternalServerError
	NotImplemented      = responses.NotImplemented
	ServiceUnavailable  = responses.ServiceUnavailable
	File                = responses.File
	Html                = responses.Html
	Template            = responses.Template
	Throw               = responses.Throw
	Problem             = responses.Problem
	ValidationProblem   = responses.ValidationProblem
	CreatedAt           = responses.CreatedAt
	PartialContent      = responses.PartialContent
	Streaming           = responses.Streaming
)
View Source 
var Benchmark = testifyx.Benchmark
View Source 
var Bootstrap = i.NewApplication
View Source 
var Describe = testifyx.Describe
View Source 
var NewTestClient = testifyx.NewTestClient

Functions

func Streamer 

func Streamer[T any](generator func(yield func(T) error) error) <-chan []byte

Types

type APIRoute 

type APIRoute = types.IAPIRoute

type APIRouter 

type APIRouter = types.IAPIRouter

type Application 

type Application = types.IApplication

type BackgroundTaskManager 

type BackgroundTaskManager = tasks.BackgroundTaskManager

type Body 

type Body[T any] struct {
	Value T
}

type Crumb 

type Crumb[T any] struct {
	Value T
}

type Dependency 

type Dependency[T any] struct {
	Value T
}

type HC 

type HC = testifyx.HC

type IActionResult 

type IActionResult = responses.IActionResult

type MediaType 

type MediaType = types.MediaType
const (
	ApplicationProblemJSON MediaType = types.ApplicationProblemJSON
	ApplicationJSON        MediaType = types.ApplicationJSON
	TextPlain              MediaType = types.TextPlain
	TextHTML               MediaType = types.TextHTML
	ApplicationXML         MediaType = types.ApplicationXML
	OctetStream            MediaType = types.OctetStream
	ApplicationForm        MediaType = types.ApplicationForm
	MultipartForm          MediaType = types.MultipartForm
)

type Pathway 

type Pathway[T any] struct {
	Value T
}

type Query 

type Query[T any] struct {
	Value T
}

type RequestScope 

type RequestScope = types.IRequestScope

type Scope 

type Scope[T any] struct {
	Value T
}

type Signal 

type Signal[T any] struct {
	Value T
}

type Silk 

type Silk[T any] struct {
	Value T
}

type TC 

type TC = testifyx.TC

type TestSuite 

type TestSuite = testifyx.TestSuite

type TestSuiteBench 

type TestSuiteBench = testifyx.TestSuiteBench

type UploadFile 

type UploadFile = types.UploadFile

type WebsocketManager 

type WebsocketManager = ws.WebsocketManager

Source Files

View all Source files

Directories

Path Synopsis
builders
context
dependencies
logger
middlewares
responses
tasks
testifyx
types
ws

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.