Women Coding Community - API

Platform Api to communicate with frontend and backend services.

• Women Coding Community - API
  • How to Set up Locally
    • VSCode
    • IntelliJ
    • 42Crunch
  • How to use
    • View/Edit
    • Check for errors

How to Set up Locally

Use your editor and install the relevant plugging/extension to edit and to see the APIs.

VSCode

• Install extension OpenAPI (Swagger) Editor

• About Swagger Extension

• How to Preview

IntelliJ

• How to install - Open Api (Swagger) Editor

• About Swagger Plugin

• How to Preview

42Crunch

Helpful to check if your API is corrected created and no error exist.

• Create an account in 42Crunch
• Generate Editor Token
  1. Go to User Setting after logging
  2. Go to Token > Create new token
  3. Copy the token and go to you Editor
  4. Open one of the API files, for example: api_module_about.yml
  5. Go to Path, for example /team:
  6. Click "Audit" Link above the path you want to test
  7. Provide IDE Token and proceed further
  8. The Audit Problem view page will show all the problem exist or no error will show in case of everything correct.

How to use

View/Edit

1. Open one of the API files you want to see, for example: api_about.yml
2. Open the OpenAPI View from your IDE
3. You will be able to see all paths and can start to edit
4. There are 2 servers on the swagger UI - default is set to localhost
5. Choose the correct server if you want to test the api
6. For more details check the plugging webpage

Check for errors

Follow the steps in listed in 42Crunch setup

Execute locally with CURL

• Install jq on mac:

$ brew install jq
$ curl https://wcc-cms.fly.dev/api/cms/v1/team  | jq .

The output should be like this:

{
  "data": {
    "title": "Meet our team",
    "subtitle": "Core Team",
    "description": "The core team of our community is composed of visionary directors and dynamic leaders, who bring a wealth of experience and dedication to empowering women in technology.",
    "membersByType": {
      "directors": [
        {
          "fullName": "Irina Kamalova",
          "position": "Senior Software Engineer",
          "image": {
            "path": "https://womencodingcommunity.com/assets/images/team/8.jpeg",
            "alt": "Director profile picture"
          },
          "network": [
            {
              "type": "Linkedin",
              "link": "https://www.linkedin.com/in/irina-kamalova/"
            },
            {
              "type": "Medium",
              "link": "https://iren-kamalova.medium.com/"
            }
          ]
        }
      ],
      "leads": [
        {
          "fullName": "Eleonora Belova",
          "position": "Test Automation Engineer",
          "image": {
            "path": "https://womencodingcommunity.com/assets/images/team/7.jpeg",
            "alt": "Leader profile picture"
          },
          "network": [
            {
              "type": "Linkedin",
              "link": "https://www.linkedin.com/in/eleonora-belova-7069baa5/"
            },
            {
              "type": "Github",
              "link": "https://github.com/nora-weisser"
            }
          ]
        }
      ],
      "evangelists": []
    }
  },
  "metadata": {
    "pagination": {
      "totalItems": 50,
      "totalPages": 2,
      "currentPage": 1,
      "pageSize": 25
    }
  }
}