1
0
mirror of https://github.com/gofiber/fiber.git synced 2025-02-25 03:43:54 +00:00
fiber/.github/README_ja.md

499 lines
16 KiB
Markdown
Raw Normal View History

2020-02-12 00:05:28 +01: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 00:05:28 +01: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 00:05:28 +01: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-12 23:59:27 +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">
2020-02-12 00:05:28 +01:00
</a>
2020-02-12 23:59:27 +03: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>-->
2020-02-12 00:05:28 +01:00
<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-12 01:03:48 +01:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ko.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/kr.svg">
</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 00:05:28 +01: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 00:05:28 +01: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-12 23:59:27 +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 00:05:28 +01:00
</p>
<p align="center">
2020-02-16 12:55:17 +09:00
<strong>FIber</strong>は、<a href="https://github.com/expressjs/express">Express</a>に触発された<strong>Webフレームワーク</strong>です。<a href="https://golang.org/doc/">Go</a><strong> 最速</strong>のHTTPエンジンである<a href="https://github.com/valyala/fasthttp">Fasthttp</a>で作られています。<strong>ゼロメモリアロケーション</strong><strong>パフォーマンス</strong>を念頭に置いて設計されており、<strong>迅速</strong>な開発をサポートします。
2020-02-12 00:05:28 +01:00
</p>
2020-02-11 00:31:35 +00:00
2020-02-11 01:50:56 +01:00
## ⚡️ クイックスタート
2020-02-11 00:31:35 +00:00
```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)
}
```
2020-02-11 01:50:56 +01:00
## ⚙️ インストール
2020-02-11 00:31:35 +00:00
2020-02-16 12:55:17 +09:00
まず、Goを[ダウンロード](https://golang.org/dl/)してください。 `1.11`以降が必要です。
2020-02-11 00:31:35 +00:00
2020-02-16 12:55:17 +09:00
そして、[`go get`](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them)コマンドを使用してインストールしてください。
2020-02-11 00:31:35 +00:00
```bash
2020-03-01 08:44:10 +01:00
go get -u github.com/gofiber/fiber/...
2020-02-11 00:31:35 +00:00
```
2020-02-11 01:50:56 +01:00
## 🤖 ベンチマーク
2020-02-11 00:31:35 +00:00
2020-02-16 12:55:17 +09:00
これらのテストは[TechEmpower](https://github.com/TechEmpower/FrameworkBenchmarks)および[Go Web](https://github.com/smallnest/go-web-framework-benchmark)によって計測を行っています 。すべての結果を表示するには、 [Wiki](https://fiber.wiki/benchmarks)にアクセスしてください。
2020-02-11 00:31:35 +00:00
<p float="left" align="middle">
2020-02-11 02:31:22 +01:00
<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%">
2020-02-11 00:31:35 +00:00
</p>
2020-02-11 01:50:56 +01:00
## 🎯 機能
2020-02-11 00:31:35 +00:00
- 堅牢な[ルーティング](https://fiber.wiki/routing)
2020-02-16 12:55:17 +09:00
- [静的ファイル](https://fiber.wiki/application#static)のサポート
2020-02-11 00:31:35 +00:00
- 究極の[パフォーマンス](https://fiber.wiki/benchmarks)
- [低メモリ](https://fiber.wiki/benchmarks)フットプリント
- Express [APIエンドポイント](https://fiber.wiki/context)
2020-02-16 12:55:17 +09:00
- Middlewareと[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/)をもっと知る
2020-02-11 00:31:35 +00:00
2020-02-11 01:50:56 +01:00
## 💡 哲学
2020-02-11 00:31:35 +00:00
2020-02-16 12:55:17 +09:00
[Node.js](https://nodejs.org/en/about/)から[Go](https://golang.org/doc/) に乗り換えようとしている新しいGopherはWebフレームワークやマイクロサービスの構築を始める前に多くを学ばなければなりません。
しかし、 **Webフレームワーク**であるFiberは**ミニマリズム**と**UNIX哲学**をもとに作られているため、新しいGopherはスムーズにGoの世界に入ることができます。
2020-02-11 00:31:35 +00:00
2020-02-16 12:55:17 +09:00
Fiberは人気の高いWebフレームワークであるExpressjsに**インスパイア**されています。
わたしたちは Expressの**手軽さ**とGoの**パフォーマンス**を組み合わせました。
もしも、WebフレームワークをExpress等のNode.jsフレームワークで実装した経験があれば、多くの方法や原理がとても**馴染み深い**でしょう。
2020-02-11 00:31:35 +00:00
2020-02-11 01:50:56 +01:00
## 👀 例
2020-02-11 00:31:35 +00:00
2020-02-16 12:55:17 +09:00
以下に一般的な例をいくつか示します。他のコード例をご覧になりたい場合は、 [Recipesリポジトリ](https://github.com/gofiber/recipes)または[APIドキュメント](https://fiber.wiki)にアクセスしてください。
2020-02-11 00:31:35 +00:00
2020-02-16 18:00:14 +01:00
### Routing
2020-02-11 00:31:35 +00:00
2020-02-16 18:00:14 +01:00
```go
func main() {
app := fiber.New()
2020-02-11 00:31:35 +00: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-11 00:31:35 +00: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-11 00:31:35 +00: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-11 00:31:35 +00:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-11 00:31:35 +00:00
2020-03-04 13:55:12 +01:00
### Serve static files
https://fiber.wiki/application#static
```go
func main() {
app := fiber.New()
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
2020-02-11 00:31:35 +00:00
2020-03-04 13:55:12 +01:00
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-11 00:31:35 +00: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-11 00:31:35 +00: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-11 00:31:35 +00:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-11 00:31:35 +00: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-11 00:31:35 +00:00
2020-02-16 18:00:14 +01:00
### Custom 404 response
2020-02-11 00:31:35 +00:00
2020-02-16 18:00:14 +01:00
```go
func main() {
app := fiber.New()
2020-02-11 00:31:35 +00: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-11 00:31:35 +00: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-11 00:31:35 +00: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-11 00:31:35 +00:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-11 00:31:35 +00: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!")
})
2020-02-14 02:05:39 +01:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
</details>
2020-03-04 13:55:12 +01:00
2020-02-11 01:50:56 +01:00
## 💬 メディア
2020-02-11 00:31:35 +00:00
- [ファイバーへようこそ— Go with❤で記述されたExpress.jsスタイルのWebフレームワーク](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497) *[ヴィック・ショースタク](https://github.com/koddr) 、2020年2月3日*
2020-02-11 01:50:56 +01:00
## 👍 貢献する
2020-02-11 00:31:35 +00:00
2020-02-16 12:55:17 +09:00
`Fiber`に開発支援してくださるなら:
2020-02-11 00:31:35 +00:00
2020-02-16 12:55:17 +09:00
1. [GitHub Star](https://github.com/gofiber/fiber/stargazers)をつけてください 。
2. [あなたのTwitterで](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)プロジェクトについてツイートしてください。
2020-02-11 00:31:35 +00:00
3. [Medium](https://medium.com/) 、 [Dev.to、](https://dev.to/)または個人のブログでレビューまたはチュートリアルを書いてください。
4. この`README`と[APIドキュメント](https://fiber.wiki/)を別の言語に翻訳するためにご協力ください。
2020-02-12 23:59:27 +03: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-11 00:31:35 +00:00
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>
## ⭐️ スター
2020-02-11 00:31:35 +00: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-11 01:50:56 +01:00
## ⚠️ ライセンス
2020-02-11 00:31:35 +00:00
2020-02-16 12:55:17 +09:00
`Fiber`は、 [MIT License](https://github.com/gofiber/fiber/blob/master/LICENSE)に基づいてライセンスされた無料のオープンソースソフトウェアです。