Skip to content

Instantly share code, notes, and snippets.

@oscarzhou
oscarzhou / API.md
Created May 9, 2018 23:35 — forked from iros/API.md
Documenting your REST API

Title

<Additional information about your API call. Try to use verbs that match both request type (fetching vs modifying) and plurality (one vs multiple).>

  • URL

    <The URL Structure (path only, no root url)>

  • Method:

package main
import (
"fmt"
"log"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/sqs"
package main
import (
"bufio"
"fmt"
"io"
"math"
"os"
"strconv"
"strings"
package main
import (
"fmt"
"sort"
)
func main() {
s := []rune("helloworld")
s1 := []rune(s[0:5])
package main
import (
"flag"
"fmt"
)
func main() {
var version string
package main
import (
"flag"
"fmt"
)
type Profile struct {
Name string
Age uint
package main
import (
"encoding/json"
"flag"
"fmt"
)
type Profile struct {
Name string