1
0
mirror of https://github.com/gofiber/fiber.git synced 2025-02-24 10:23:56 +00:00
fiber/.github/README_ko.md

493 lines
16 KiB
Markdown
Raw Normal View History

2020-02-12 08:04:36 +09:00
<p align="center">
<a href="https://fiber.wiki">
2020-02-21 16:56:32 +01:00
<img alt="Fiber" height="125" src="https://github.com/gofiber/docs/blob/master/static/fiber_v2_logo.svg">
2020-02-12 08:04:36 +09:00
</a>
2020-02-21 16:56:32 +01:00
<br>
2020-02-14 02:05:39 +01:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README.md">
2020-02-12 08:04:36 +09:00
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/gb.svg">
</a>
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ru.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/ru.svg">
</a>
2020-02-13 00:02:00 +03:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_es.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/es.svg">
</a>
2020-02-12 08:04:36 +09:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ja.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/jp.svg">
</a>
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_pt.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/pt.svg">
</a>
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_zh-CN.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/cn.svg">
</a>
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_de.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/de.svg">
</a>
2020-02-13 00:02:00 +03:00
<!--<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ko.md">
2020-02-12 01:03:06 +01:00
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/kr.svg">
2020-02-13 00:02:00 +03:00
</a>-->
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_fr.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/fr.svg">
</a>
2020-02-19 15:48:41 +03:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_tr.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/tr.svg">
</a>
2020-03-05 23:20:30 +11:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_id.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/id.svg">
</a>
2020-02-12 08:04:36 +09:00
<br><br>
<a href="https://github.com/gofiber/fiber/releases">
<img src="https://img.shields.io/github/release/gofiber/fiber?style=flat-square">
</a>
<a href="https://fiber.wiki">
<img src="https://img.shields.io/badge/api-documentation-blue?style=flat-square">
</a>
2020-02-22 11:09:32 +08:00
<a href="https://pkg.go.dev/github.com/gofiber/fiber?tab=doc">
<img src="https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square">
</a>
2020-02-12 08:04:36 +09:00
<a href="#">
<img src="https://img.shields.io/badge/goreport-A%2B-brightgreen?style=flat-square">
</a>
<a href="https://gocover.io/github.com/gofiber/fiber">
<img src="https://img.shields.io/badge/coverage-91%25-brightgreen?style=flat-square">
</a>
<a href="https://travis-ci.org/gofiber/fiber">
<img src="https://img.shields.io/travis/gofiber/fiber/master.svg?label=linux&style=flat-square">
</a>
<a href="https://travis-ci.org/gofiber/fiber">
<img src="https://img.shields.io/travis/gofiber/fiber/master.svg?label=windows&style=flat-square">
</a>
2020-02-13 00:02:00 +03:00
<a href="https://travis-ci.org/gofiber/fiber">
<img src="https://img.shields.io/travis/gofiber/fiber/master.svg?label=osx&style=flat-square">
</a>
2020-02-12 08:04:36 +09:00
</p>
<p align="center">
2020-02-16 00:54:39 +09:00
<b>Fiber</b><a href="https://github.com/expressjs/express">Express</a>에서 영감을 받고, <a href="https://golang.org/doc/">Go</a>를 위한 <b>가장 빠른</b> HTTP 엔진인 <a ref="https://github.com/valyala/fasthttp">Fasthttp</a>를 토대로 만들어진 <b>웹 프레임워크</b> 입니다. <b>비 메모리 할당</b><b>성능</b>을 고려한 <b>빠른</b> 개발을 위해 <b>손쉽게</b> 사용되도록 설계되었습니다.
2020-02-12 08:04:36 +09:00
</p>
## ⚡️ 빠른 시작
```go
package main
import "github.com/gofiber/fiber"
func main() {
app := fiber.New()
app.Get("/", func(c *fiber.Ctx) {
c.Send("Hello, World!")
})
app.Listen(3000)
}
```
## ⚙️ 설치
우선, Go를 [다운로드](https://golang.org/dl/)하고 설치합니다. `1.11` 버전 이상이 요구됩니다.
[`go get`](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) 명령어를 이용해 설치가 완료됩니다:
```bash
2020-03-01 08:44:10 +01:00
go get -u github.com/gofiber/fiber/...
2020-02-12 08:04:36 +09:00
```
## 🤖 벤치마크
이 테스트들은 [TechEmpower](https://github.com/TechEmpower/FrameworkBenchmarks)와 [Go Web](https://github.com/smallnest/go-web-framework-benchmark)을 통해 측정되었습니다. 만약 모든 결과를 보고 싶다면, [Wiki](https://fiber.wiki/benchmarks)를 확인해 주세요.
<p float="left" align="middle">
<img src="https://github.com/gofiber/docs/blob/master/.gitbook/assets//benchmark-pipeline.png" width="49%">
<img src="https://github.com/gofiber/docs/blob/master/.gitbook/assets//benchmark_alloc.png" width="49%">
</p>
## 🎯 특징
- 견고한 [라우팅](https://fiber.wiki/routing)
- [정적 파일](https://fiber.wiki/application#static) 제공
- 뛰어난 [성능](https://fiber.wiki/benchmarks)
- [적은 메모리](https://fiber.wiki/benchmarks) 공간
- [API 엔드포인트](https://fiber.wiki/context)
- 미들웨어 & [Next](https://fiber.wiki/context#next) 지원
- [빠른](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497) 서버 사이드 프로그래밍
- [5개 언어](https://fiber.wiki/)로 번역됨
- 더 알고 싶다면, [Fiber 둘러보기](https://fiber.wiki/)
## 💡 철학
[Node.js](https://nodejs.org/en/about/)에서 [Go](https://golang.org/doc/)로 전환하는 새로운 고퍼분들은 웹 어플리케이션이나 마이크로 서비스 개발을 시작할 수 있게 되기 전에 학습 곡선에 시달리고 있습니다. Fiber는 **web framework**로서, 새로운 고퍼분들이 따뜻하고 믿음직한 환영을 가지고 빠르게 Go의 세상에 진입할 수 있게 **미니멀리즘**의 개념과 **UNIX 방식**에 따라 개발되었습니다.
Fiber는 인터넷에서 가장 인기있는 웹 프레임워크인 Express에서 **영감을 받았습니다.** 우리는 Express의 쉬운 사용과 Go의 성능을 결합하였습니다. 만약 당신이 Node.js (Express 또는 비슷한 것을 사용하여) 로 웹 어플리케이션을 개발한 경험이 있다면, 많은 메소드들과 원리들이 매우 비슷하게 느껴질 것 입니다.
## 👀 예제
다음은 일반적인 예제들 입니다. 더 많은 코드 예제를 보고 싶다면, [Recipes 저장소](https://github.com/gofiber/recipes) 또는 [API 문서](https://fiber.wiki)를 방문하세요.
2020-02-16 18:00:14 +01:00
### Routing
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
```go
func main() {
app := fiber.New()
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
// GET /john
app.Get("/:name", func(c *fiber.Ctx) {
fmt.Printf("Hello %s!", c.Params("name"))
// => Hello john!
})
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
// GET /john
app.Get("/:name/:age?", func(c *fiber.Ctx) {
fmt.Printf("Name: %s, Age: %s", c.Params("name"), c.Params("age"))
// => Name: john, Age:
})
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
// GET /api/register
app.Get("/api*", func(c *fiber.Ctx) {
fmt.Printf("/api%s", c.Params("*"))
// => /api/register
})
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-12 08:04:36 +09:00
2020-03-04 13:55:12 +01:00
### Serve static files
https://fiber.wiki/application#static
```go
func main() {
app := fiber.New()
2020-02-12 08:04:36 +09:00
2020-03-04 13:55:12 +01:00
app.Static("/", "/public")
// => http://localhost:3000/js/script.js
// => http://localhost:3000/css/style.css
app.Static("/prefix", "/public")
// => http://localhost:3000/prefix/js/script.js
// => http://localhost:3000/prefix/css/style.css
app.Static("*", "/public/index.html")
// => http://localhost:3000/any/path/shows/index/html
app.Listen(3000)
}
```
### Middleware & Next
https://fiber.wiki/routing#middleware
https://fiber.wiki/context#next
2020-02-16 18:00:14 +01:00
```go
func main() {
app := fiber.New()
// Match any route
app.Use(func(c *fiber.Ctx) {
fmt.Println("First middleware")
c.Next()
})
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
// Match all routes starting with /api
app.Use("/api", func(c *fiber.Ctx) {
fmt.Println("Second middleware")
c.Next()
})
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
// POST /api/register
app.Post("/api/register", func(c *fiber.Ctx) {
fmt.Println("Last middleware")
c.Send("Hello, World!")
})
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-12 08:04:36 +09:00
2020-02-14 02:24:06 +01:00
<details>
2020-03-04 13:55:12 +01:00
<summary>📚 Show more code examples</summary>
### Template engines
https://fiber.wiki/application#settings
https://fiber.wiki/context#render
Supported engines:
- [html](https://golang.org/pkg/html/template/)
- [amber](https://github.com/eknkc/amber)
- [handlebars](https://github.com/aymerick/raymond)
- [mustache](https://github.com/cbroglie/mustache)
- [pug](https://github.com/Joker/jade)
```go
func main() {
// You can setup template engine before initiation app:
app := fiber.New(&fiber.Settings{
TemplateEngine: "mustache",
TemplateFolder: "./views",
TemplateExtension: ".tmpl",
})
// OR after initiation app at any convenient location:
app.Settings.TemplateEngine = "mustache"
app.Settings.TemplateFolder = "./views"
app.Settings.TemplateExtension = ".tmpl"
// And now, you can call template `./views/home.tmpl` like this:
app.Get("/", func(c *fiber.Ctx) {
c.Render("home", fiber.Map{
"title": "Homepage",
"year": 1999,
})
})
// ...
}
```
### Grouping routes into chains
https://fiber.wiki/application#group
```go
func main() {
app := fiber.New()
// Root API route
api := app.Group("/api", cors()) // /api
// API v1 routes
v1 := api.Group("/v1", mysql()) // /api/v1
v1.Get("/list", handler) // /api/v1/list
v1.Get("/user", handler) // /api/v1/user
// API v2 routes
v2 := api.Group("/v2", mongodb()) // /api/v2
v2.Get("/list", handler) // /api/v2/list
v2.Get("/user", handler) // /api/v2/user
// ...
}
```
### Middleware logger
https://fiber.wiki/middleware#logger
```go
import (
"github.com/gofiber/fiber"
"github.com/gofiber/fiber/middleware"
)
func main() {
app := fiber.New()
// If you want to change default Logger config
loggerConfig := middleware.LoggerConfig{
Format: "${time} - ${method} ${path}\n",
TimeFormat: "Mon, 2 Jan 2006 15:04:05 MST",
}
// Middleware for Logger with config
app.Use(middleware.Logger(loggerConfig))
// ...
}
```
### Cross-Origin Resource Sharing (CORS)
https://fiber.wiki/middleware#cors
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is a mechanism that uses additional HTTP headers to tell browsers to give a web application running at one origin, access to selected resources from a different origin. A web application executes a cross-origin HTTP request when it requests a resource that has a different origin (domain, protocol, or port) from its own.
```go
import (
"github.com/gofiber/fiber"
"github.com/gofiber/fiber/middleware"
)
func main() {
app := fiber.New()
// Connect CORS for each route as middleware
app.Use(middleware.CORS())
app.Get("/", func(c *fiber.Ctx) {
c.Send("CORS is enabled!")
})
app.Listen(3000)
}
```
Check CORS by passing any domain in `Origin` header:
```bash
curl -H "Origin: http://example.com" --verbose http://localhost:3000
```
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
### Custom 404 response
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
```go
func main() {
app := fiber.New()
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
app.Static("/public")
2020-03-04 13:55:12 +01:00
2020-02-16 18:00:14 +01:00
app.Get("/demo", func(c *fiber.Ctx) {
c.Send("This is a demo!")
})
2020-03-04 13:55:12 +01:00
2020-02-16 18:00:14 +01:00
app.Post("/register", func(c *fiber.Ctx) {
c.Send("Welcome!")
})
// Last middleware to match anything
app.Use(func(c *fiber.Ctx) {
c.SendStatus(404) // => 404 "Not Found"
})
app.Listen(3000)
}
```
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
### JSON Response
2020-03-04 13:55:12 +01:00
https://fiber.wiki/context#json
2020-02-16 18:00:14 +01:00
```go
2020-03-04 13:55:12 +01:00
type User struct {
Name string `json:"name"`
Age int `json:"age"`
}
2020-02-16 18:00:14 +01:00
func main() {
app := fiber.New()
2020-03-04 13:55:12 +01:00
app.Get("/user", func(c *fiber.Ctx) {
c.JSON(&User{"John", 20})
// {"name":"John", "age":20}
})
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
app.Get("/json", func(c *fiber.Ctx) {
2020-03-04 13:55:12 +01:00
c.JSON(&fiber.Map{
"success": true,
"message": "Hi John!",
})
// {"success":true, "message":"Hi John!"}
2020-02-16 18:00:14 +01:00
})
2020-02-12 08:04:36 +09:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-12 08:04:36 +09:00
2020-03-04 13:55:12 +01:00
### WebSocket support
https://fiber.wiki/application#websocket
```go
func main() {
app := fiber.New()
app.WebSocket("/ws", func(c *fiber.Conn) {
for {
mt, msg, err := c.ReadMessage()
if err != nil {
log.Println("read:", err)
break
}
log.Printf("recovery: %s", msg)
err = c.WriteMessage(mt, msg)
if err != nil {
log.Println("write:", err)
break
}
}
})
2020-02-14 02:05:39 +01:00
2020-03-04 13:55:12 +01:00
// Listen on ws://localhost:3000/ws
app.Listen(3000)
}
```
2020-02-14 02:05:39 +01:00
2020-03-04 13:55:12 +01:00
### Recover middleware
https://fiber.wiki/middleware#recover
2020-02-16 18:00:14 +01:00
```go
2020-03-04 13:55:12 +01:00
package main
import (
"github.com/gofiber/fiber"
"github.com/gofiber/fiber/middleware"
)
2020-02-16 18:00:14 +01:00
func main() {
app := fiber.New()
2020-02-14 02:05:39 +01:00
2020-03-04 13:55:12 +01:00
app.Use(middleware.Recover(func(c *fiber.Ctx, err error) {
log.Println(err) // "Something went wrong!"
c.SendStatus(500) // Internal Server Error
})))
2020-02-16 18:00:14 +01:00
app.Get("/", func(c *fiber.Ctx) {
panic("Something went wrong!")
})
app.Listen(3000)
}
```
</details>
2020-02-14 02:05:39 +01:00
2020-02-12 08:04:36 +09:00
## 💬 미디어
- [Welcome to Fiber — an Express.js styled web framework written in Go with ❤️](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497) _by [Vic Shóstak](https://github.com/koddr), 03 Feb 2020_
## 👍 기여
2020-02-13 00:02:00 +03:00
`Fiber`의 활발한 개발을 지원하고 감사 인사를 하고 싶다면:
2020-02-12 08:04:36 +09:00
1. 프로젝트에 [GitHub Star](https://github.com/gofiber/fiber/stargazers)를 추가하세요.
2. [트위터에서](https://twitter.com/intent/tweet?text=%F0%9F%9A%80%20Fiber%20%E2%80%94%20is%20an%20Express.js%20inspired%20web%20framework%20build%20on%20Fasthttp%20for%20%23Go%20https%3A%2F%2Fgithub.com%2Fgofiber%2Ffiber) 프로젝트에 대해 트윗하세요.
3. [Medium](https://medium.com/), [Dev.to](https://dev.to/) 또는 개인 블로그에 리뷰 또는 튜토리얼을 작성하세요.
4. `README` 와 [API 문서](https://fiber.wiki/)를 다른 언어로 번역하는 것을 도와주세요.
2020-02-12 03:54:54 +01:00
## ☕ Supporters
2020-02-16 18:00:14 +01:00
<a href="https://www.buymeacoffee.com/fenny" target="_blank">
<img src="https://github.com/gofiber/docs/blob/master/static/buy-morning-coffee-3x.gif" alt="Buy Me A Coffee" height="100" >
</a>
2020-02-12 03:54:54 +01:00
<table>
<tr>
2020-03-04 14:02:22 +01:00
<td align="center">
<a href="https://github.com/gofiber/fiber">
<img src="https://i.stack.imgur.com/frlIf.png" width="100px"></br>
<sub><b>JustDave</b></sub>
</a>
</td>
2020-02-12 03:54:54 +01:00
<td align="center">
2020-02-14 02:05:39 +01:00
<a href="https://github.com/bihe">
2020-02-16 18:00:14 +01:00
<img src="https://avatars1.githubusercontent.com/u/635852?s=460&v=4" width="100px"></br>
2020-02-14 02:05:39 +01:00
<sub><b>HenrikBinggl</b></sub>
2020-02-12 03:54:54 +01:00
</a>
2020-02-14 02:05:39 +01:00
</td>
<td align="center">
<a href="https://github.com/koddr">
2020-02-16 18:00:14 +01:00
<img src="https://avatars0.githubusercontent.com/u/11155743?s=460&v=4" width="100px"></br>
2020-03-04 14:02:22 +01:00
<sub><b>Vic&nbsp;Shóstak</b></sub>
2020-02-14 02:05:39 +01:00
</a>
</td>
<td align="center">
<a href="https://github.com/MarvinJWendt">
2020-02-16 18:00:14 +01:00
<img src="https://avatars1.githubusercontent.com/u/31022056?s=460&v=4" width="100px"></br>
2020-02-14 02:05:39 +01:00
<sub><b>MarvinJWendt</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/toishy">
2020-02-16 18:00:14 +01:00
<img src="https://avatars1.githubusercontent.com/u/31921460?s=460&v=4" width="100px"></br>
2020-02-14 02:05:39 +01:00
<sub><b>ToishY</b></sub>
</a>
</td>
2020-02-12 03:54:54 +01:00
</tr>
</table>
## ⭐️ Stars
2020-02-12 08:04:36 +09:00
<a href="https://starchart.cc/gofiber/fiber" rel="nofollow"><img src="https://starchart.cc/gofiber/fiber.svg" alt="Stars over time" style="max-width:100%;"></a>
## ⚠️ 라이센스
2020-02-13 00:02:00 +03:00
`Fiber` 는 [MIT License](https://github.com/gofiber/fiber/blob/master/LICENSE)에 따른 무료 오픈소스 소프트웨어 입니다.