Initial commit
This commit is contained in:
fabio
62
hello/hello.go
Normal file
62
hello/hello.go
Normal file
@@ -0,0 +1,62 @@
|
||||
// Service hello implements a simple hello world REST API.
|
||||
package hello
|
||||
|
||||
import (
|
||||
"context"
|
||||
)
|
||||
|
||||
// Welcome to Encore!
|
||||
// This is a simple "Hello World" project to get you started.
|
||||
//
|
||||
// To run it, execute "encore run" in your favorite shell.
|
||||
|
||||
// ==================================================================
|
||||
|
||||
// This is a public REST API that responds with a personalized greeting.
|
||||
// Learn more about defining APIs with Encore:
|
||||
// https://encore.dev/docs/primitives/services-and-apis
|
||||
//
|
||||
// To call it, run in your terminal:
|
||||
//
|
||||
// curl http://localhost:4000/hello/World
|
||||
//
|
||||
//encore:api public path=/hello/:name
|
||||
func World(ctx context.Context, name string) (*Response, error) {
|
||||
msg := "Hello, " + name + "!"
|
||||
return &Response{Message: msg}, nil
|
||||
}
|
||||
|
||||
type Response struct {
|
||||
Message string
|
||||
}
|
||||
|
||||
// ==================================================================
|
||||
|
||||
// Encore comes with a built-in local development dashboard for
|
||||
// exploring your API, viewing documentation, debugging with
|
||||
// distributed tracing, and more:
|
||||
//
|
||||
// http://localhost:9400
|
||||
//
|
||||
|
||||
// ==================================================================
|
||||
|
||||
// Next steps
|
||||
//
|
||||
// 1. Deploy your application to the cloud
|
||||
//
|
||||
// git add -A .
|
||||
// git commit -m 'Commit message'
|
||||
// git push encore
|
||||
//
|
||||
// 2. To continue exploring Encore, check out some of these topics:
|
||||
//
|
||||
// Defining Services: https://encore.dev/docs/go/primitives/services
|
||||
// Defining APIs: https://encore.dev/docs/go/primitives/defining-apis
|
||||
// Using SQL databases: https://encore.dev/docs/go/primitives/databases
|
||||
// Using Pub/Sub: https://encore.dev/docs/go/primitives/pubsub
|
||||
// Authenticating users: https://encore.dev/docs/go/develop/auth
|
||||
// Building a REST API: https://encore.dev/docs/go/tutorials/rest-api
|
||||
// Building an Event-Driven app: https://encore.dev/docs/go/tutorials/uptime
|
||||
// Building a Slack bot: https://encore.dev/docs/go/tutorials/slack-bot
|
||||
// Example apps repo: https://github.com/encoredev/examples
|
||||
22
hello/hello_test.go
Normal file
22
hello/hello_test.go
Normal file
@@ -0,0 +1,22 @@
|
||||
package hello
|
||||
|
||||
import (
|
||||
"context"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// Run tests using `encore test`, which compiles the Encore app and then runs `go test`.
|
||||
// It supports all the same flags that the `go test` command does.
|
||||
// You automatically get tracing for tests in the local dev dash: http://localhost:9400
|
||||
// Learn more: https://encore.dev/docs/go/develop/testing
|
||||
func TestWorld(t *testing.T) {
|
||||
const in = "Jane Doe"
|
||||
resp, err := World(context.Background(), in)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if got := resp.Message; !strings.Contains(got, in) {
|
||||
t.Errorf("World(%q) = %q, expected to contain %q", in, got, in)
|
||||
}
|
||||
}
|
||||
69
hello/index.go
Normal file
69
hello/index.go
Normal file
@@ -0,0 +1,69 @@
|
||||
package hello
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"encore.dev"
|
||||
)
|
||||
|
||||
// Landing page with usage instructions.
|
||||
//
|
||||
//encore:api public raw path=/!path
|
||||
func Index(w http.ResponseWriter, req *http.Request) {
|
||||
baseUrl := encore.Meta().APIBaseURL.String()
|
||||
|
||||
w.Header().Set("Content-Type", "text/html")
|
||||
w.Write([]byte(strings.ReplaceAll(landingPage, "{{baseUrl}}", baseUrl)))
|
||||
}
|
||||
|
||||
const landingPage = `<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Hello World</title>
|
||||
<style>
|
||||
* { margin: 0; padding: 0; box-sizing: border-box; }
|
||||
body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif; background: #0a0a0a; color: #e5e5e5; padding: 2rem; max-width: 720px; margin: 0 auto; line-height: 1.6; }
|
||||
h1 { font-size: 1.75rem; margin-bottom: 0.5rem; color: #fff; }
|
||||
h2 { font-size: 1.1rem; margin-top: 2rem; margin-bottom: 0.75rem; color: #fff; }
|
||||
p { margin-bottom: 1rem; color: #a3a3a3; }
|
||||
code { background: #1a1a1a; padding: 0.15rem 0.4rem; border-radius: 4px; font-size: 0.9em; color: #e5e5e5; }
|
||||
pre { background: #1a1a1a; border: 1px solid #262626; border-radius: 8px; padding: 1rem; overflow-x: auto; margin-bottom: 1rem; }
|
||||
pre code { background: none; padding: 0; }
|
||||
.endpoint { display: flex; align-items: center; gap: 0.5rem; margin-bottom: 0.5rem; }
|
||||
.method { font-size: 0.75rem; font-weight: 600; padding: 0.2rem 0.5rem; border-radius: 4px; font-family: monospace; }
|
||||
.get { background: #15803d; color: #fff; }
|
||||
.path { font-family: monospace; color: #e5e5e5; }
|
||||
.desc { color: #737373; font-size: 0.9rem; margin-bottom: 1.25rem; }
|
||||
a { color: #60a5fa; }
|
||||
.badge { display: inline-block; background: #15803d; color: #fff; font-size: 0.7rem; padding: 0.15rem 0.5rem; border-radius: 999px; margin-left: 0.5rem; font-weight: 600; vertical-align: middle; position: relative; top: -0.15em; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Hello World <span class="badge">Encore.go</span></h1>
|
||||
<p>A simple REST API to get you started with Encore. This is the simplest possible Encore app, with a single endpoint that returns a greeting.</p>
|
||||
|
||||
<p>Explore and test endpoints in the <a href="http://localhost:9400/">Local Dashboard</a> when running locally. When deployed to <a href="https://app.encore.cloud">Encore Cloud</a>, use the Service Catalog to call endpoints and view traces to see how requests flow between services.</p>
|
||||
|
||||
<h2>Try it</h2>
|
||||
|
||||
<div class="endpoint">
|
||||
<span class="method get">GET</span>
|
||||
<span class="path">/hello/:name</span>
|
||||
<code>hello.World</code>
|
||||
</div>
|
||||
<p class="desc">Returns a personalized greeting.</p>
|
||||
<pre><code>curl {{baseUrl}}/hello/World</code></pre>
|
||||
|
||||
<h2>Next steps</h2>
|
||||
<p>Check out these topics to keep building:</p>
|
||||
<p>
|
||||
<a href="https://encore.dev/docs/go/tutorials/rest-api">Building a REST API</a> ·
|
||||
<a href="https://encore.dev/docs/go/primitives/services">Defining Services</a> ·
|
||||
<a href="https://encore.dev/docs/go/primitives/databases">Using SQL Databases</a> ·
|
||||
<a href="https://encore.dev/docs/go/primitives/pubsub">Using Pub/Sub</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>`
|
||||
Reference in New Issue
Block a user