Skip to content

Inconsistencies in API specification #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
apicarve opened this issue Nov 18, 2022 · 0 comments
Open

Inconsistencies in API specification #43

apicarve opened this issue Nov 18, 2022 · 0 comments

Comments

@apicarve
Copy link

apicarve commented Nov 18, 2022

Hello, we are building a research tool to generate API test suites and API specification automatically using UI test suites. When we compared the API specification we generate for your web app with the specification provided along with the web application, we found a few inconsistencies. Would you consider this to be a problem with the API specification or with the application?

Here are the API endpoints for which the server provided a 2xx or a 3xx status but the specification does not include them.

			"-options",
			"-head",
			"/articles/{var15}-options",
			"/articles/{var15}-head",
			"/profiles/{var9}-options",
			"/profiles/{var9}-head",
			"/articles/{var14}-options",
			"/articles/{var14}-head",
			"/tags-options",
			"/tags-head",
			"/articles/{var11}-options",
			"/articles/{var11}-head",
			"/articles/{var10}-options",
			"/articles/{var10}-head",
			"/articles/{var36}/comments-options",
			"/articles/{var36}/comments-head",
			"/profiles/{var13}-options",
			"/profiles/{var13}-head",
			"/articles-options",
			"/articles-head"

For example -get means that we tried the HTTP request GET on the API endpoint / and received a status 200 from the server for http://localhost:3000/api but there is no corresponding operation defined in the specification.

This particular root endpoint provided a health check but the original specification does not mention it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant