profile

profile

| | |

A service used on a web site for a person profile (Web Site) github.

With support for

• Get sections
• Get sections with contents
• Get a section
• Get a section contents

Endpoints

• Get sections:

  Method: GET

  Route: http://localhost:9001/api/v1/profile/sections

  Body:

  [
      {
          "id_section": "1",
          "key": "home",
          "name": "Home",
          "description": "Home Section",
      },
      {
          "id_section": "2",
          "key": "projects",
          "name": "Projects",
          "description": "Projects Section",
      },
      {
          "id_section": "3",
          "key": "about",
          "name": "About",
          "description": "About Section",
      }
  ]
  

• Get sections with contents:

  Method: GET

  Route: http://localhost:9001/api/v1/profile/sections/contents

  Body:

  [
      {
          "id_section": "1",
          "key": "home",
          "name": "Hello",
          "description": "Home Section",
          "contents": [
              {
                  "id_content": "1",
                  "key": "hello",
                  "type": "project",
                  "content": {
                      "url": "https://www.facebook.com/joaosoft",
                      "title": "I'm João Ribeiro",
                      "description": "I like to code."
                  }
              }
          ]
      },
      {
          "id_section": "2",
          "key": "projects",
          "name": "Projects",
          "description": "Projects Section",
          "contents": [
              {
                  "id_content": "2",
                  "key": "dbr",
                  "type": "project",
                  "content": {
                      "url": "https://github.com/joaosoft/dbr",
                      "build": "https://travis-ci.org/joaosoft/dbr.svg?branch=master",
                      "title": "Dbr",
                      "description": "A simple database client with support for master/slave databases."
                  }
              },
              {
                  "id_content": "3",
                  "key": "web",
                  "type": "project",
                  "content": {
                      "url": "https://github.com/joaosoft/web",
                      "build": "https://travis-ci.org/joaosoft/web.svg?branch=master",
                      "title": "Web",
                      "description": "A simple and fast web server and client."
                  }
              },
              {
                  "id_content": "4",
                  "key": "validator",
                  "type": "project",
                  "content": {
                      "url": "https://github.com/joaosoft/validator",
                      "build": "https://travis-ci.org/joaosoft/validator.svg?branch=master",
                      "title": "Validator",
                      "description": "A simple struct validator by tags."
                  }
              }
          ]
      },
      {
          "id_section": "3",
          "key": "about",
          "name": "Goodbye",
          "description": "About Section",
          "contents": [
              {
                  "id_content": "5",
                  "key": "goodbuye",
                  "type": "project",
                  "content": {
                      "url": "https://www.facebook.com/joaosoft",
                      "title": "Thanks for reading",
                      "description": "Find more about me..."
                  }
              }
          ]
      }
  ]
  

• Get a section:

  Method: PUT

  Route: http://localhost:9001/api/v1/profile/sections/home

  Body:

  {
      "id_section": "1",
      "key": "home",
      "name": "Home",
      "description": "Home Section",
  }
  

• Get a section contents:

  Method: PUT

  Route: http://localhost:9001/api/v1/profile/sections/projects/contents

  Body:

  {
      "id_section": "2",
      "key": "projects",
      "name": "Projects",
      "description": "Projects Section",
      "contents": [
          {
              "id_content": "2",
              "key": "dbr",
              "type": "project",
              "content": {
                  "url": "https://github.com/joaosoft/dbr",
                  "build": "https://travis-ci.org/joaosoft/dbr.svg?branch=master",
                  "title": "Dbr",
                  "description": "A simple database client with support for master/slave databases."
              }
          },
          {
              "id_content": "3",
              "key": "web",
              "type": "project",
              "content": {
                  "url": "https://github.com/joaosoft/web",
                  "build": "https://travis-ci.org/joaosoft/web.svg?branch=master",
                  "title": "Web",
                  "description": "A simple and fast web server and client."
              }
          },
          {
              "id_content": "4",
              "key": "validator",
              "type": "project",
              "content": {
                  "url": "https://github.com/joaosoft/validator",
                  "build": "https://travis-ci.org/joaosoft/validator.svg?branch=master",
                  "title": "Validator",
                  "description": "A simple struct validator by tags."
              }
          }
      ]
  }
  

Dependecy Management

Dependency

Project dependencies are managed using Dep. Read more about Dep.

• Get dependency manager: go get github.com/joaosoft/dependency
• Install dependencies: dependency get

Go

go get github.com/joaosoft/profile

Known issues

Follow me at

Facebook: https://www.facebook.com/joaosoft

LinkedIn: https://www.linkedin.com/in/jo%C3%A3o-ribeiro-b2775438/