OpenAPI / Swagger ਦਰਸ਼ਕ

ਬ੍ਰਾਊਜ਼ਰ ਵਿੱਚ ਸਿੱਧੇ OpenAPI ਅਤੇ Swagger API ਦਸਤਾਵੇਜ਼ਾਂ (YAML/JSON) ਨੂੰ ਇੰਟਰਐਕਟਿਵ ਤਰੀਕੇ ਨਾਲ ਵੇਖੋ ਅਤੇ ਟੈਸਟ ਕਰੋ।

OpenAPI / Swagger ਦਰਸ਼ਕ ਬਾਰੇ — ਵਿਸਤ੍ਰਿਤ ਗਾਈਡ

ਸ਼੍ਰੇਣੀ: DevOps ਅਤੇ ਮਿਆਰ 100% ਬ੍ਰਾਊਜ਼ਰ ਵਿੱਚ ਲੋਕਲ

OpenAPI Viewer RESTful API ਕੰਟਰੈਕਟਸ ਦੀ ਜਾਂਚ ਕਰਨ ਲਈ ਇੱਕ ਕਲਾਇੰਟ-ਸਾਈਡ ਦਸਤਾਵੇਜ਼ ਰੀਡਰ ਹੈ। ਇਹ ਲੋਕਲ Swagger UI ਇੰਸਟਾਲੇਸ਼ਨ ਜਾਂ ਕਲਾਊਡ ਨਿਰਭਰਤਾਵਾਂ ਤੋਂ ਬਿਨਾਂ JSON ਜਾਂ YAML ਵਿੱਚ Swagger 2.0 ਅਤੇ OpenAPI 3.0 / 3.1 ਨਿਰਧਾਰਨਾਂ ਨੂੰ ਰੈਂਡਰ ਕਰਦਾ ਹੈ।

ਇਹ ਸਾਰੇ ਐਂਡਪੁਆਇੰਟਸ ਲਈ ਇੱਕ ਸਾਫ਼ ਸਮੂਹੀਕ੍ਰਿਤ ਸਾਈਡਬਾਰ ਨੈਵੀਗੇਸ਼ਨ ਪੇਸ਼ ਕਰਦਾ ਹੈ, ਜਿਸ ਵਿੱਚ ਪਾਥ, HTTP ਮੈਥਡ (GET, POST, PUT, DELETE), ਹੈਡਰ ਪੈਰਾਮੀਟਰ, ਕਿਊਰੀ ਸਟ੍ਰਿੰਗਜ਼, ਸੰਰਚਿਤ ਬੇਨਤੀ ਬਾਡੀਜ਼, HTTP ਰਿਸਪਾਂਸ ਕੋਡ ਅਤੇ ਡੇਟਾ ਸਕੀਮਾ ਸ਼ਾਮਲ ਹਨ।

#openapi #swagger #api #docs #rest #yaml #json

ਮੁੱਖ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਅਤੇ ਸਮਰੱਥਾਵਾਂ

  • JSON ਅਤੇ YAML ਵਿੱਚ Swagger 2.0 ਅਤੇ OpenAPI 3.0 / 3.1 ਨਿਰਧਾਰਨਾਂ ਦਾ ਸਮਰਥਨ ਕਰਦਾ ਹੈ
  • ਸ਼੍ਰੇਣੀਬੱਧ ਐਂਡਪੁਆਇੰਟਸ, HTTP ਮੈਥਡ ਅਤੇ ਸਥਿਤੀ ਕੋਡ ਸੂਚੀਬੱਧ ਕਰਨ ਵਾਲਾ ਇੰਟਰਐਕਟਿਵ ਸਾਈਡਬਾਰ
  • ਡੂੰਘਾ `$ref` ਸਕੀਮਾ ਰੈਜ਼ੋਲਿਊਸ਼ਨ ਜੋ ਨੇਸਟਡ ਡੇਟਾ ਮਾਡਲਾਂ ਅਤੇ ਵਿਸ਼ੇਸ਼ਤਾ ਪਾਬੰਦੀਆਂ ਨੂੰ ਦਰਸਾਉਂਦਾ ਹੈ
  • ਮਲਕੀਅਤ ਵਾਲੇ ਐਂਟਰਪ੍ਰਾਈਜ਼ API ਕੰਟਰੈਕਟਸ ਨੂੰ ਸੁਰੱਖਿਅਤ ਰੱਖਣ ਵਾਲੀ 100% ਕਲਾਇੰਟ-ਸਾਈਡ ਔਫਲਾਈਨ ਪਾਰਸਿੰਗ

ਵਰਤੋਂ ਕਿਵੇਂ ਕਰੀਏ

  1. 1

    ਆਪਣਾ `swagger.json` ਜਾਂ `openapi.yaml` ਟੈਕਸਟ ਪੇਸਟ ਕਰੋ, ਜਾਂ ਸਪੈਕ ਫਾਈਲ ਸਿੱਧੇ ਅੱਪਲੋਡ ਕਰੋ।

  2. 2

    ਇੰਟਰਐਕਟਿਵ ਵਿਊਅਰ ਵਿੱਚ ਰੈਂਡਰ ਕੀਤੇ ਗਏ ਸੰਰਚਿਤ API ਦਸਤਾਵੇਜ਼ਾਂ ਨੂੰ ਬ੍ਰਾਊਜ਼ ਕਰੋ।

  3. 3

    ਬੇਨਤੀ ਹੈਡਰ, ਬੇਨਤੀ ਪੇਲੋਡ ਸਕੀਮਾ ਅਤੇ ਰਿਸਪਾਂਸ ਨਮੂਨਿਆਂ ਦੀ ਜਾਂਚ ਕਰਨ ਲਈ ਕਿਸੇ ਵੀ ਐਂਡਪੁਆਇੰਟ ਦਾ ਵਿਸਤਾਰ ਕਰੋ।

ਆਮ ਵਰਤੋਂ ਦੇ ਮਾਮਲੇ

  • → ਸਮਰਪਿਤ Swagger UI ਸਰਵਰ ਪ੍ਰੋਵਿਜ਼ਨ ਕੀਤੇ ਬਿਨਾਂ ਬੈਕਐਂਡ API ਪਰਿਭਾਸ਼ਾਵਾਂ ਦਾ ਆਡਿਟ ਕਰਨਾ
  • → ਅਵੈਧ `$ref` ਪੁਆਇੰਟਰਾਂ ਲਈ ਹੱਥ ਨਾਲ ਲਿਖੇ OpenAPI ਨਿਰਧਾਰਨਾਂ ਦੀ ਮੁੱਢਲੀ ਜਾਂਚ (sanity-check) ਕਰਨਾ
  • → API ਏਕੀਕਰਣ ਦੌਰਾਨ ਫਰੰਟਐਂਡ ਇੰਜੀਨੀਅਰਾਂ ਨੂੰ ਸਹੀ ਸਕੀਮਾ ਹਵਾਲੇ ਪ੍ਰਦਾਨ ਕਰਨਾ

ਸਬੰਧਤ ਟੂਲ

SEO ਅਤੇ ਸੋਸ਼ਲ ਮੈਟਾ ਟੈਗ ਜਨਰੇਟਰ

ਖੋਜ ਇੰਜਣਾਂ ਅਤੇ ਸੋਸ਼ਲ ਨੈੱਟਵਰਕਾਂ ਲਈ Open Graph, Twitter Cards ਅਤੇ ਜ਼ਰੂਰੀ SEO ਮੈਟਾ ਟੈਗ ਤਿਆਰ ਕਰੋ।

.gitignore ਫਾਈਲ ਜਨਰੇਟਰ

Node.js, Python, Java, Go, Rust, macOS, Windows ਅਤੇ ਦਰਜਨਾਂ ਵਾਤਾਵਰਣਾਂ ਲਈ .gitignore ਫਾਈਲਾਂ ਤਿਆਰ ਕਰੋ।

ਓਪਨ ਸੋਰਸ ਲਾਇਸੈਂਸ ਜਨਰੇਟਰ

ਆਪਣੇ ਨਾਮ ਅਤੇ ਸਾਲ ਨਾਲ ਮਿਆਰੀ ਓਪਨ ਸੋਰਸ ਲਾਇਸੈਂਸ (MIT, Apache 2.0, GPL v3, BSD) ਤਿਆਰ ਕਰੋ।

README.md ਫਾਈਲ ਜਨਰੇਟਰ

ਬੈਜ, ਸਥਾਪਨਾ ਨਿਰਦੇਸ਼ਾਂ ਅਤੇ ਸੈਕਸ਼ਨਾਂ ਦੇ ਨਾਲ GitHub ਪ੍ਰੋਜੈਕਟਾਂ ਲਈ ਪੇਸ਼ੇਵਰ README ਦਸਤਾਵੇਜ਼ ਬਣਾਓ।

Conventional Commits ਸਹਾਇਕ

Conventional Commits ਨਿਯਮਾਂ (feat, fix, chore, docs, ਆਦਿ) ਦੀ ਪਾਲਣਾ ਕਰਦੇ ਹੋਏ ਮਿਆਰੀ ਗਿਟ ਕਮਿਟ ਸੰਦੇਸ਼ ਬਣਾਓ।

SemVer ਕੈਲਕੁਲੇਟਰ ਅਤੇ ਤੁਲਨਾਕਾਰ

ਸਿਮੈਂਟਿਕ ਵਰਜ਼ਨ (SemVer) ਦੀ ਪੁਸ਼ਟੀ ਕਰੋ, ਵਰਜਨਾਂ ਦੀ ਤੁਲਨਾ ਕਰੋ ਅਤੇ ਅਗਲੇ ਵਰਜਨ ਵਾਧੇ (major, minor, patch) ਦੀ ਗਣਨਾ ਕਰੋ।

ਅਕਸਰ ਪੁੱਛੇ ਜਾਣ ਵਾਲੇ ਸਵਾਲ ਅਤੇ ਪਰਦੇਦਾਰੀ

ਕੀ ਇਹ ਟੂਲ ਸਿੱਧੇ YAML ਨਿਰਧਾਰਨ ਪੜ੍ਹ ਸਕਦਾ ਹੈ?

ਹਾਂ। ਇੱਕ ਏਮਬੈਡਡ YAML ਪਾਰਸਰ ਬ੍ਰਾਊਜ਼ਰ ਵਿੱਚ ਹੀ `.yaml` ਅਤੇ `.json` OpenAPI ਕੰਟਰੈਕਟ ਨਿਰਧਾਰਨਾਂ ਦੋਵਾਂ ਨੂੰ ਪੂਰੀ ਤਰ੍ਹਾਂ ਪ੍ਰੋਸੈਸ ਕਰਦਾ ਹੈ।

ਕੀ ਮੇਰਾ ਮਲਕੀਅਤ ਵਾਲਾ API ਨਿਰਧਾਰਨ ਬਾਹਰੀ ਸਰਵਰਾਂ 'ਤੇ ਅੱਪਲੋਡ ਹੁੰਦਾ ਹੈ?

ਨਹੀਂ। ਸਾਰੀ ਦਸਤਾਵੇਜ਼ ਪਾਰਸਿੰਗ ਅਤੇ ਸਕੀਮਾ ਰੈਂਡਰਿੰਗ ਪੂਰੀ ਤਰ੍ਹਾਂ ਤੁਹਾਡੀ ਲੋਕਲ ਬ੍ਰਾਊਜ਼ਰ ਮੈਮੋਰੀ ਵਿੱਚ ਚਲਦੀ ਹੈ।