Skip to main content
Stack Apps

Return to Question

added 1 character in body; edited tags
Source Link
Brock Adams
Brock Adams
  • 13k
  • 5
  • 39
  • 64

I am struggling a little bit with the StackexchangeStack Exchange API since there seems to be no formal specification for the individual endpoints of the API.

Example:

Endpoint: https://api.stackexchange.com/2.2/questions/add

Documentation Link: https://api.stackexchange.com/docs/create-question

On the screenshot you can see all the information I get for the endpoint. A few things weren't clear at first sight:

  1. Is this a POST request or would GET also work?
  2. What is the Content-Type (x-www-form-urlencoded or json ?)
  3. Which fields are required which are optional
  4. Description of all the fields:
    • What is preview for. What is the format: [true,false], ["true","false"], [0,1]?
    • How to format the list of tags?
    • What is the key, where to get it
    • How do responses look like (e.g. HTTP headers)
    • How would an example request look like

I did find out all of this information eventually but I had to make assumptions and do quite a bit of trial and error.

In contrast, the GithubGitHub API for example has a different structure and provides most of the data at a glance. Example: Create an GithubGitHub Issue

Screenshot

screenshot

I am struggling a little bit with the Stackexchange API since there seems to be no formal specification for the individual endpoints of the API.

Example:

Endpoint: https://api.stackexchange.com/2.2/questions/add

Documentation Link: https://api.stackexchange.com/docs/create-question

On the screenshot you can see all the information I get for the endpoint. A few things weren't clear at first sight:

  1. Is this a POST request or would GET also work?
  2. What is the Content-Type (x-www-form-urlencoded or json ?)
  3. Which fields are required which are optional
  4. Description of all the fields:
    • What is preview for. What is the format: [true,false], ["true","false"], [0,1]?
    • How to format the list of tags?
    • What is the key, where to get it
    • How do responses look like (e.g. HTTP headers)
    • How would an example request look like

I did find out all of this information eventually but I had to make assumptions and do quite a bit of trial and error.

In contrast, the Github API for example has a different structure and provides most of the data at a glance. Example: Create an Github Issue

Screenshot

screenshot

I am struggling a little bit with the Stack Exchange API since there seems to be no formal specification for the individual endpoints of the API.

Example:

Endpoint: https://api.stackexchange.com/2.2/questions/add

Documentation Link: https://api.stackexchange.com/docs/create-question

On the screenshot you can see all the information I get for the endpoint. A few things weren't clear at first sight:

  1. Is this a POST request or would GET also work?
  2. What is the Content-Type (x-www-form-urlencoded or json ?)
  3. Which fields are required which are optional
  4. Description of all the fields:
    • What is preview for. What is the format: [true,false], ["true","false"], [0,1]?
    • How to format the list of tags?
    • What is the key, where to get it
    • How do responses look like (e.g. HTTP headers)
    • How would an example request look like

I did find out all of this information eventually but I had to make assumptions and do quite a bit of trial and error.

In contrast, the GitHub API for example has a different structure and provides most of the data at a glance. Example: Create an GitHub Issue

Screenshot

screenshot

deleted 9 characters in body
Source Link
Besi
Besi
  • 533
  • 3
  • 10

I am struggling a little bit with the Stackexchange API since there seems to be no formal specification for the individual endpoints of the API.

Example:

Endpoint: https://api.stackexchange.com/2.2/questions/add

Documentation Link: https://api.stackexchange.com/docs/create-question

On the screenshot you can see all the information I get for the endpoint. A few things weren't clear at first sight:

  1. Is this a POST request or would GET also work?
  2. What is the Content-Type (x-www-form-urlencoded or json ?)
  3. Which fields are required which are optional
  4. Description of all the fields:
    • What is preview for. What is the format: [true,false], ["true","false"], [0,1]?
    • How to format the list of tags?
    • What is the key, where to get it
    • How do responses look like (e.g. HTTP headers)
    • How would an example request look like

TheI did find out all of this information eventually but I had to make assumptions and do quite a bit of trial and error.

In contrast, the Github API for example has a different structure and provides most of the data I was unsure in this case at a glance. Example: Create an Github Issue

I did find out all of this information eventually but I had to make assumptions and do quite a bit of trial and error.

Screenshot

screenshot

I am struggling a little bit with the Stackexchange API since there seems to be no formal specification for the individual endpoints of the API.

Example:

Endpoint: https://api.stackexchange.com/2.2/questions/add

Documentation Link: https://api.stackexchange.com/docs/create-question

On the screenshot you can see all the information I get for the endpoint. A few things weren't clear at first sight:

  1. Is this a POST request or would GET also work?
  2. What is the Content-Type (x-www-form-urlencoded or json ?)
  3. Which fields are required which are optional
  4. Description of all the fields:
    • What is preview for. What is the format: [true,false], ["true","false"], [0,1]?
    • How to format the list of tags?
    • What is the key, where to get it
    • How do responses look like (e.g. HTTP headers)
    • How would an example request look like

The Github API for example has a different structure and provides most of the data I was unsure in this case at a glance. Example: Create an Github Issue

I did find out all of this information eventually but I had to make assumptions and do quite a bit of trial and error.

Screenshot

screenshot

I am struggling a little bit with the Stackexchange API since there seems to be no formal specification for the individual endpoints of the API.

Example:

Endpoint: https://api.stackexchange.com/2.2/questions/add

Documentation Link: https://api.stackexchange.com/docs/create-question

On the screenshot you can see all the information I get for the endpoint. A few things weren't clear at first sight:

  1. Is this a POST request or would GET also work?
  2. What is the Content-Type (x-www-form-urlencoded or json ?)
  3. Which fields are required which are optional
  4. Description of all the fields:
    • What is preview for. What is the format: [true,false], ["true","false"], [0,1]?
    • How to format the list of tags?
    • What is the key, where to get it
    • How do responses look like (e.g. HTTP headers)
    • How would an example request look like

I did find out all of this information eventually but I had to make assumptions and do quite a bit of trial and error.

In contrast, the Github API for example has a different structure and provides most of the data at a glance. Example: Create an Github Issue

Screenshot

screenshot

Source Link
Besi
Besi
  • 533
  • 3
  • 10

Incomplete information in API documentation

I am struggling a little bit with the Stackexchange API since there seems to be no formal specification for the individual endpoints of the API.

Example:

Endpoint: https://api.stackexchange.com/2.2/questions/add

Documentation Link: https://api.stackexchange.com/docs/create-question

On the screenshot you can see all the information I get for the endpoint. A few things weren't clear at first sight:

  1. Is this a POST request or would GET also work?
  2. What is the Content-Type (x-www-form-urlencoded or json ?)
  3. Which fields are required which are optional
  4. Description of all the fields:
    • What is preview for. What is the format: [true,false], ["true","false"], [0,1]?
    • How to format the list of tags?
    • What is the key, where to get it
    • How do responses look like (e.g. HTTP headers)
    • How would an example request look like

The Github API for example has a different structure and provides most of the data I was unsure in this case at a glance. Example: Create an Github Issue

I did find out all of this information eventually but I had to make assumptions and do quite a bit of trial and error.

Screenshot

screenshot