Skip to content

Latest commit

 

History

History
353 lines (280 loc) · 13.5 KB

README_es_ES.md

File metadata and controls

353 lines (280 loc) · 13.5 KB
Raw

Martini wercker statusGoDoc

Martini es un poderoso paquete para escribir rápidamente aplicaciones/servicios web modulares en Golang.

Vamos a iniciar

Antes de instalar Go y de configurar su GOPATH, cree su primer archivo .go. Vamos a llamar a este server.go.

package main

import "github.com/go-martini/martini"

func main() {
  m := martini.Classic()
  m.Get("/", func() string {
    return "Hola Mundo!"
  })
  m.Run()
}

Luego instale el paquete Martini (Es necesario go 1.1 o superior):

go get github.com/go-martini/martini

Después corra su servidor:

go run server.go

Ahora tendrá un webserver Martini corriendo en el puerto localhost:3000.

Obtenga ayuda

Suscribase a la Lista de email

Observe el Video demostrativo

Use la etiqueta martini para preguntas en Stackoverflow

GoDoc documentation

Caracteríticas

  • Extremadamente simple de usar.
  • Diseño no intrusivo.
  • Buena integración con otros paquetes Golang.
  • Enrutamiento impresionante.
  • Diseño modular - Fácil de añadir y remover funcionalidades.
  • Muy buen uso de handlers/middlewares.
  • Grandes características innovadoras.
  • Compatibilidad total con la interface http.HandlerFunc.

Más Middlewares

Para más middlewares y funcionalidades, revisar los repositorios en martini-contrib.

Lista de contenidos

Classic Martini

Para iniciar rápidamente, martini.Classic() prevee algunas herramientas que funcionan bien para la mayoría de aplicaciones web:

  m := martini.Classic()
  // middlewares y rutas aquí
  m.Run()

Algunas funcionalidades que martini.Classic() ofrece automáticamente son:

Handlers

Handlers son el corazón y el alma de Martini. Un handler es básicamente cualquier tipo de función que puede ser llamada.

m.Get("/", func() {
  println("hola mundo")
})

Retorno de Valores

Si un handler retorna cualquier cosa, Martini escribirá el valor retornado como una cadena http.ResponseWriter:

m.Get("/", func() string {
  return "hola mundo" // HTTP 200 : "hola mundo"
})

Usted también puede retornar un código de estado:

m.Get("/", func() (int, string) {
  return 418, "soy una tetera" // HTTP 418 : "soy una tetera"
})

Inyección de Servicios

Handlers son invocados vía reflexión. Martini utiliza Inyección de Dependencia para resolver dependencias en la lista de argumentos Handlers. Esto hace que Martini sea completamente compatible con la interface http.HandlerFunc de golang.

Si agrega un argumento a su Handler, Martini buscará en su lista de servicios e intentará resolver su dependencia vía su tipo de aserción:

m.Get("/", func(res http.ResponseWriter, req *http.Request) { // res e req son inyectados por Martini
  res.WriteHeader(200) // HTTP 200
})

Los siguientes servicios son incluidos con martini.Classic():

Rutas

En Martini, una ruta es un método HTTP emparejado con un patrón URL. Cada ruta puede tener uno o más métodos handler:

m.Get("/", func() {
  // mostrar algo
})

m.Patch("/", func() {
  // actualizar algo
})

m.Post("/", func() {
  // crear algo
})

m.Put("/", func() {
  // reemplazar algo
})

m.Delete("/", func() {
  // destruir algo
})

m.Options("/", func() {
  // opciones HTTP
})

m.NotFound(func() {
  // manipula 404
})

Las rutas son emparejadas en el orden en que son definidas. La primera ruta que coincide con la solicitud es invocada.

Los patrones de rutas puede incluir nombres como parámetros accesibles vía el servicio martini.Params:

m.Get("/hello/:name", func(params martini.Params) string {
  return "Hello " + params["name"]
})

Las rutas se pueden combinar con globs:

m.Get("/hello/**", func(params martini.Params) string {
  return "Hello " + params["_1"]
})

Las expresiones regulares puede ser usadas también:

m.Get("/hello/(?P<name>[a-zA-Z]+)", func(params martini.Params) string {
  return fmt.Sprintf ("Hello %s", params["name"])
})

Observe la documentación para mayor información sobre la sintaxis de expresiones regulares.

Handlers de ruta pueden ser empilados en la cima de otros, la cual es útil para cosas como autenticación y autorización:

m.Get("/secret", authorize, func() {
  // será ejecutado cuando autorice escribir una respuesta
})

Grupos de rutas puede ser añadidas usando el método Group.

m.Group("/books", func(r martini.Router) {
    r.Get("/:id", GetBooks)
    r.Post("/new", NewBook)
    r.Put("/update/:id", UpdateBook)
    r.Delete("/delete/:id", DeleteBook)
})

Igualmente como puede pasar middlewares para un handler, usted puede pasar middlewares para grupos.

m.Group("/books", func(r martini.Router) {
    r.Get("/:id", GetBooks)
    r.Post("/new", NewBook)
    r.Put("/update/:id", UpdateBook)
    r.Delete("/delete/:id", DeleteBook)
}, MyMiddleware1, MyMiddleware2)

Servicios

Servicios son objetos que están disponibles para ser inyectados en una lista de argumentos Handler. Usted puede mapear un servicios a nivel Global o Request.

Mapeamento Global

Una instancia de Martini implementa la interface inject.Injector, entonces un mapeamiento de un servicio es fácil:

db := &MyDatabase{}
m := martini.Classic()
m.Map(db) // el servicio estará disponible para todos los handlers como *MyDatabase.
// ...
m.Run()

Mapeamiento por Request

Mapeamiento a nivel de request se puede realizar un handler vía martini.Context:

func MyCustomLoggerHandler(c martini.Context, req *http.Request) {
  logger := &MyCustomLogger{req}
  c.Map(logger) // mapeado como *MyCustomLogger
}

Valores de Mapeamiento para Interfaces

Una de las partes mas poderosas sobre servicios es la capadidad de mapear un servicio para una interface. Por ejemplo, si desea sobreescribir http.ResponseWriter con un objeto que envuelva y realice operaciones extra, puede escribir el siguiente handler:

func WrapResponseWriter(res http.ResponseWriter, c martini.Context) {
  rw := NewSpecialResponseWriter(res)
  c.MapTo(rw, (*http.ResponseWriter)(nil)) // sobreescribir ResponseWriter con nuestro ResponseWriter
}

Sirviendo Archivos Estáticos

Una instancia de martini.Classic() sirve automáticamente archivos estáticos del directorio "public" en la raíz de su servidor. Usted puede servir más directorios, añadiendo más martini.Static handlers.

m.Use(martini.Static("assets")) // sirviendo los archivos del directorio "assets"

Middleware Handlers

Middleware Handlers se sitúan entre una solicitud HTTP y un router. En esencia, ellos no son diferentes de cualquier otro Handler en Martini. Usted puede añadir un handler de middleware para la pila de la siguiente forma:

m.Use(func() {
  // Hacer algo con middleware
})

Puede tener el control total sobre la pila de middleware con la función Handlers. Esto reemplazará a cualquier handler que se ha establecido previamente:

m.Handlers(
  Middleware1,
  Middleware2,
  Middleware3,
)

Middleware Handlers trabaja realmente bien como logging, autorización, autenticación, sessión, gzipping, páginas de errores y una serie de otras operaciones que deben suceder antes de una solicitud http:

// Valida una llave de api
m.Use(func(res http.ResponseWriter, req *http.Request) {
  if req.Header.Get("X-API-KEY") != "secret123" {
    res.WriteHeader(http.StatusUnauthorized)
  }
})

Next()

Context.Next() es una función opcional que Middleware Handlers puede llamar para aguardar una ejecución de otros Handlers. Esto trabaja muy bien para calquier operación que debe suceder antes de una solicitud http:

// log antes y después de una solicitud
m.Use(func(c martini.Context, log *log.Logger){
  log.Println("antes de una solicitud")

  c.Next()

  log.Println("luego de una solicitud")
})

Martini Env

Martini handlers hace uso de martini.Env, una variable global para proveer funcionalidad especial en ambientes de desarrollo y ambientes de producción. Es recomendado que una variable MARTINI_ENV=production sea definida cuando se despliegue en un ambiente de producción.

FAQ

¿Dónde puedo encontrar una middleware X?

Inicie su búsqueda en los proyectos martini-contrib. Si no esta allí, no dude en contactar a algún miembro del equipo martini-contrib para adicionar un nuevo repositorio para la organización.

  • auth - Handlers para autenticación.
  • binding - Handler para mapeamiento/validación de un request en una estrutura.
  • gzip - Handler para agregar gzip comprimidos para requests
  • render - Handler que provee un servicio de fácil renderizado JSON y plantillas HTML.
  • acceptlang - Handler para analizar Accept-Language header HTTP.
  • sessions - Handler que provee un servicio de sesión.
  • strip - URL Prefix stripping.
  • method - HTTP método de sobreescritura vía header o campos de formulario.
  • secure - Implementa rápidamente items de seguridad.
  • encoder - Servicio de encoder para renderización de datos en varios formatos y negocios de contenidos.
  • cors - Handler que habilita suporte a CORS.
  • oauth2 - Handler que provee sistema de login OAuth 2.0 para aplicaciones Martini. Google Sign-in, Facebook Connect y Github login son soportados.

¿Cómo se integra con los servidores existentes?

Una instancia de Martini implementa http.Handler, de modo que puede ser fácilmente utilizado para servir sub-rutas y directorios en servidores Go existentes. Por ejemplo, este es un aplicativo Martini trabajando para Google App Engine:

package hello

import (
  "net/http"
  "github.com/go-martini/martini"
)

func init() {
  m := martini.Classic()
  m.Get("/", func() string {
    return "Hola Mundo!"
  })
  http.Handle("/", m)
}

¿Cómo cambiar el puerto/host?

La función Run de Martini observa las variables PORT e HOST para utilizarlas. Caso contrário, Martini asume por defecto localhost:3000. Para tener maayor flexibilidad sobre el puerto y host, use la función http.ListenAndServe.

  m := martini.Classic()
  // ...
  log.Fatal(http.ListenAndServe(":8080", m))

¿Servidor con autoreload?

gin y fresh son aplicaciones para autorecarga de Martini.

Contribuyendo

Martini se desea mantener pequeño y limpio. La mayoría de contribuciones deben realizarse en el repositorio martini-contrib. Si desea hacer una contribución al core de Martini es libre de realizar un Pull Request.

Sobre

Inspirado por express y sinatra

Martini está diseñoado obsesivamente por nada menos que Code Gangsta