ਜੱਫੀ | ਪਾਈਥਨ-ਸੰਚਾਲਿਤ APIs ਦਾ ਵਿਕਾਸ ਕਰਨਾ ਸਰਲ ਬਣਾਇਆ ਗਿਆ ਹੈ
ਨਵੀਨਤਮ ਦਸਤਾਵੇਜ਼ ਪੜ੍ਹੋ - GitHub ਕੋਡ ਰਿਪੋਜ਼ਟਰੀ ਬ੍ਰਾਊਜ਼ ਕਰੋ
ਹੱਗ ਦਾ ਉਦੇਸ਼ ਪਾਇਥਨ ਦੁਆਰਾ ਚਲਾਏ API ਨੂੰ ਜਿੰਨਾ ਸੰਭਵ ਹੋ ਸਕੇ ਸਧਾਰਨ ਬਣਾਉਣਾ ਹੈ, ਪਰ ਕੋਈ ਸੌਖਾ ਨਹੀਂ। ਨਤੀਜੇ ਵਜੋਂ, ਇਹ ਪਾਈਥਨ API ਵਿਕਾਸ ਨੂੰ ਬਹੁਤ ਜ਼ਿਆਦਾ ਸਰਲ ਬਣਾਉਂਦਾ ਹੈ।
ਹੱਗ ਦੇ ਡਿਜ਼ਾਈਨ ਉਦੇਸ਼:
- ਇੱਕ ਲਿਖਤੀ ਪਰਿਭਾਸ਼ਾ ਦੇ ਰੂਪ ਵਿੱਚ ਇੱਕ ਪਾਈਥਨ ਸੰਚਾਲਿਤ API ਨੂੰ ਸੰਖਿਪਤ ਬਣਾਓ।
- ਫਰੇਮਵਰਕ ਨੂੰ ਕੋਡ ਨੂੰ ਉਤਸ਼ਾਹਿਤ ਕਰਨਾ ਚਾਹੀਦਾ ਹੈ ਜੋ ਸਵੈ-ਦਸਤਾਵੇਜ਼ ਕਰਦਾ ਹੈ।
- ਇਹ ਤੇਜ਼ ਹੋਣਾ ਚਾਹੀਦਾ ਹੈ. ਇੱਕ ਡਿਵੈਲਪਰ ਨੂੰ ਪ੍ਰਦਰਸ਼ਨ ਦੇ ਕਾਰਨਾਂ ਕਰਕੇ ਕਿਤੇ ਹੋਰ ਦੇਖਣ ਦੀ ਜ਼ਰੂਰਤ ਮਹਿਸੂਸ ਨਹੀਂ ਕਰਨੀ ਚਾਹੀਦੀ।
- ਹੱਗ ਦੇ ਸਿਖਰ 'ਤੇ ਲਿਖੇ API ਲਈ ਟੈਸਟ ਲਿਖਣਾ ਆਸਾਨ ਅਤੇ ਅਨੁਭਵੀ ਹੋਣਾ ਚਾਹੀਦਾ ਹੈ।
- ਏਪੀਆਈ ਫਰੇਮਵਰਕ ਵਿੱਚ ਇੱਕ ਵਾਰ ਕੀਤਾ ਗਿਆ ਜਾਦੂ, API ਫਰੇਮਵਰਕ ਦੇ ਉਪਭੋਗਤਾ ਨੂੰ ਸੈੱਟ ਕੀਤੀ ਸਮੱਸਿਆ ਨੂੰ ਧੱਕਣ ਨਾਲੋਂ ਬਿਹਤਰ ਹੈ।
- ਨਵੀਨਤਮ ਤਕਨਾਲੋਜੀ ਨੂੰ ਅਪਣਾਉਂਦੇ ਹੋਏ, ਅਗਲੀ ਪੀੜ੍ਹੀ ਦੇ ਪਾਈਥਨ API ਦਾ ਆਧਾਰ ਬਣੋ।
ਇਹਨਾਂ ਟੀਚਿਆਂ ਦੇ ਨਤੀਜੇ ਵਜੋਂ, ਹੱਗ ਸਿਰਫ਼ Python 3+ ਹੈ ਅਤੇ Falcon ਦੀ ਉੱਚ ਪ੍ਰਦਰਸ਼ਨ ਵਾਲੀ HTTP ਲਾਇਬ੍ਰੇਰੀ 'ਤੇ ਬਣਾਇਆ ਗਿਆ ਹੈ।
ਗਲੇ ਦੇ ਵਿਕਾਸ ਦਾ ਸਮਰਥਨ ਕਰਨਾ
Tidelift ਸਬਸਕ੍ਰਿਪਸ਼ਨ ਦੇ ਨਾਲ ਪੇਸ਼ੇਵਰ ਤੌਰ 'ਤੇ ਸਮਰਥਿਤ ਜੱਫੀ ਪ੍ਰਾਪਤ ਕਰੋ
ਟਾਈਡਲਿਫਟ ਸਬਸਕ੍ਰਿਪਸ਼ਨ ਦੇ ਹਿੱਸੇ ਵਜੋਂ ਜੱਫੀ ਲਈ ਪੇਸ਼ੇਵਰ ਸਹਾਇਤਾ ਉਪਲਬਧ ਹੈ। ਟਾਈਡਲਿਫਟ ਸਾਫਟਵੇਅਰ ਡਿਵੈਲਪਮੈਂਟ ਟੀਮਾਂ ਨੂੰ ਉਹਨਾਂ ਦੇ ਸੌਫਟਵੇਅਰ ਨੂੰ ਖਰੀਦਣ ਅਤੇ ਉਹਨਾਂ ਦੀ ਸਾਂਭ-ਸੰਭਾਲ ਕਰਨ ਲਈ ਇੱਕ ਸਿੰਗਲ ਸਰੋਤ ਪ੍ਰਦਾਨ ਕਰਦਾ ਹੈ, ਉਹਨਾਂ ਮਾਹਰਾਂ ਤੋਂ ਪੇਸ਼ੇਵਰ ਗ੍ਰੇਡ ਭਰੋਸੇ ਦੇ ਨਾਲ ਜੋ ਇਸਨੂੰ ਸਭ ਤੋਂ ਵਧੀਆ ਜਾਣਦੇ ਹਨ, ਮੌਜੂਦਾ ਟੂਲਸ ਨਾਲ ਸਹਿਜੇ ਹੀ ਏਕੀਕ੍ਰਿਤ ਕਰਦੇ ਹੋਏ।
ਜੱਫੀ ਸਥਾਪਤ ਕੀਤੀ ਜਾ ਰਹੀ ਹੈ
ਗਲੇ ਲਗਾਉਣਾ ਇੰਨਾ ਸੌਖਾ ਹੈ ਜਿਵੇਂ:
|_+_|ਆਦਰਸ਼ਕ ਤੌਰ 'ਤੇ, ਇੱਕ ਵਰਚੁਅਲ ਵਾਤਾਵਰਣ ਦੇ ਅੰਦਰ।
ਸ਼ੁਰੂ ਕਰਨਾ
ਸਿਰਫ਼ ਕੁਝ ਲਾਈਨਾਂ ਵਿੱਚ ਇੱਕ ਸਧਾਰਨ ਅੰਤ ਬਿੰਦੂ ਦੇ ਨਾਲ ਇੱਕ ਉਦਾਹਰਨ API ਬਣਾਓ।
|_+_|ਚਲਾਉਣ ਲਈ, ਕਮਾਂਡ ਲਾਈਨ ਤੋਂ ਟਾਈਪ ਕਰੋ:
|_+_|ਤੁਸੀਂ ਆਪਣੇ ਬ੍ਰਾਊਜ਼ਰ ਵਿੱਚ ਇਸ ਉਦਾਹਰਨ ਤੱਕ ਪਹੁੰਚ ਕਰ ਸਕਦੇ ਹੋ: |_+_|। ਫਿਰ |_+_| 'ਤੇ ਆਪਣੇ API ਲਈ ਦਸਤਾਵੇਜ਼ਾਂ ਦੀ ਜਾਂਚ ਕਰੋ
ਪੈਰਾਮੀਟਰਾਂ ਨੂੰ URL ਵਿੱਚ ਵੀ ਏਨਕੋਡ ਕੀਤਾ ਜਾ ਸਕਦਾ ਹੈ (ਚੈੱਕ ਆਉਟ ਕਰੋ |_+_| ਪੂਰੀ ਉਦਾਹਰਨ ਲਈ).
|_+_|ਜੋ, ਇੱਕ ਵਾਰ ਜਦੋਂ ਤੁਸੀਂ ਸਰਵਰ ਨੂੰ ਉੱਪਰ ਦੇ ਤੌਰ ਤੇ ਚਲਾ ਰਹੇ ਹੋ, ਤਾਂ ਤੁਸੀਂ ਇਸ ਤਰੀਕੇ ਨਾਲ ਵਰਤ ਸਕਦੇ ਹੋ:
|_+_|ਜੱਫੀ ਨਾਲ ਸੰਸਕਰਣ
|_+_|ਉਦਾਹਰਣ ਨੂੰ ਚਲਾਉਣ ਲਈ:
|_+_|ਫਿਰ ਤੁਸੀਂ |_+_| ਤੋਂ ਉਦਾਹਰਨ ਤੱਕ ਪਹੁੰਚ ਕਰ ਸਕਦੇ ਹੋ / |_+_| ਜਾਂ |_+_| ਤੋਂ ਆਪਣੇ API ਲਈ ਦਸਤਾਵੇਜ਼ਾਂ ਤੱਕ ਪਹੁੰਚ ਕਰੋ
ਨੋਟ: ਹੱਗ ਵਿੱਚ ਵਰਜਨਿੰਗ ਆਪਣੇ ਆਪ ਹੀ ਸੰਸਕਰਣ ਸਿਰਲੇਖ ਦੇ ਨਾਲ-ਨਾਲ ਸਿੱਧੇ URL ਅਧਾਰਤ ਨਿਰਧਾਰਨ ਦੋਵਾਂ ਦਾ ਸਮਰਥਨ ਕਰਦੀ ਹੈ।
ਹੱਗ API ਦੀ ਜਾਂਚ ਕੀਤੀ ਜਾ ਰਹੀ ਹੈ
ਜੱਫੀ |_+_| ਵਿਧੀ ਸਜਾਵਟ ਕਰਨ ਵਾਲੇ ਤੁਹਾਡੇ ਅਸਲ ਫੰਕਸ਼ਨਾਂ ਨੂੰ ਸੰਸ਼ੋਧਿਤ ਨਹੀਂ ਕਰਦੇ ਹਨ। ਇਹ ਹੱਗ API ਦੀ ਜਾਂਚ ਨੂੰ ਕਿਸੇ ਹੋਰ ਪਾਈਥਨ ਫੰਕਸ਼ਨਾਂ ਦੀ ਜਾਂਚ ਕਰਨ ਜਿੰਨਾ ਸੌਖਾ ਬਣਾਉਂਦਾ ਹੈ। ਇਸ ਤੋਂ ਇਲਾਵਾ, ਇਸਦਾ ਮਤਲਬ ਹੈ ਕਿ ਦੂਜੇ ਪਾਈਥਨ ਕੋਡ ਵਿੱਚ ਤੁਹਾਡੇ API ਫੰਕਸ਼ਨਾਂ ਨਾਲ ਇੰਟਰੈਕਟ ਕਰਨਾ ਓਨਾ ਹੀ ਸਿੱਧਾ ਹੈ ਜਿੰਨਾ ਪਾਇਥਨ ਨੂੰ ਸਿਰਫ਼ API ਫੰਕਸ਼ਨਾਂ ਨੂੰ ਕਾਲ ਕਰਨਾ ਹੈ। ਹੱਗ |_+_| ਦੀ ਵਰਤੋਂ ਕਰਕੇ ਤੁਹਾਡੇ API ਦੇ ਪੂਰੇ ਪਾਈਥਨ ਸਟੈਕ ਦੀ ਜਾਂਚ ਕਰਨਾ ਆਸਾਨ ਬਣਾਉਂਦਾ ਹੈ ਮੋਡੀਊਲ:
|_+_|ਤੁਸੀਂ ਇਸ ਦੀ ਵਰਤੋਂ ਕਰ ਸਕਦੇ ਹੋ |_+_| ਟੈਸਟ ਦੇ ਦਾਅਵੇ ਲਈ ਵਸਤੂ (ਚੈੱਕ ਆਉਟ ਕਰੋ |_+_| ):
|_+_|ਹੋਰ WSGI ਅਧਾਰਤ ਸਰਵਰਾਂ ਨਾਲ ਗਲੇ ਚੱਲ ਰਿਹਾ ਹੈ
ਜੱਫੀ ਇੱਕ |_+_| ਨੂੰ ਉਜਾਗਰ ਕਰਦੀ ਹੈ ਹਰ API ਮੋਡੀਊਲ 'ਤੇ ਮੈਜਿਕ ਵਿਧੀ ਆਟੋਮੈਟਿਕਲੀ। ਕਿਸੇ ਵੀ ਮਿਆਰੀ wsgi ਸਰਵਰ 'ਤੇ ਤੁਹਾਡੇ ਹੱਗ ਆਧਾਰਿਤ API ਨੂੰ ਚਲਾਉਣਾ ਓਨਾ ਹੀ ਸਰਲ ਹੋਣਾ ਚਾਹੀਦਾ ਹੈ ਜਿੰਨਾ ਇਸਨੂੰ |_+_|: |_+_| ਵੱਲ ਇਸ਼ਾਰਾ ਕਰਨਾ।
ਉਦਾਹਰਣ ਲਈ:
|_+_|ਹੈਲੋ ਵਰਲਡ ਹੱਗ ਉਦਾਹਰਨ API ਨੂੰ ਚਲਾਉਣ ਲਈ।
ਹੱਗ API ਦੇ ਬਿਲਡਿੰਗ ਬਲਾਕ
ਹੱਗ ਫਰੇਮਵਰਕ ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਹੋਏ ਇੱਕ API ਬਣਾਉਂਦੇ ਸਮੇਂ ਤੁਸੀਂ ਹੇਠਾਂ ਦਿੱਤੇ ਸੰਕਲਪਾਂ ਦੀ ਵਰਤੋਂ ਕਰੋਗੇ:
ਢੰਗ ਸਜਾਵਟ ||
|_+_|ਹੱਗ ਤੁਹਾਡੇ API ਦੇ ਉਪਭੋਗਤਾਵਾਂ ਲਈ ਸਵੈਚਲਿਤ ਤੌਰ 'ਤੇ ਦਸਤਾਵੇਜ਼ ਤਿਆਰ ਕਰਨ ਲਈ ਤੁਹਾਡੇ ਦੁਆਰਾ ਸਜਾਏ ਗਏ ਫੰਕਸ਼ਨ ਦੀ ਬਣਤਰ ਦੀ ਵਰਤੋਂ ਕਰਦਾ ਹੈ। hug ਹਮੇਸ਼ਾ ਤੁਹਾਡੇ ਫੰਕਸ਼ਨ ਲਈ ਇੱਕ ਬੇਨਤੀ, ਜਵਾਬ, ਅਤੇ api_version ਵੇਰੀਏਬਲ ਪਾਸ ਕਰਦਾ ਹੈ ਜੇਕਰ ਉਹਨਾਂ ਨੂੰ ਤੁਹਾਡੀ ਫੰਕਸ਼ਨ ਪਰਿਭਾਸ਼ਾ ਵਿੱਚ ਪਰਿਭਾਸ਼ਿਤ ਕੀਤਾ ਗਿਆ ਹੈ।
ਐਨੋਟੇਸ਼ਨ ਟਾਈਪ ਕਰੋ ਫੰਕਸ਼ਨ ਜੋ ਵਿਕਲਪਿਕ ਤੌਰ 'ਤੇ ਤੁਹਾਡੀਆਂ ਵਿਧੀਆਂ ਆਰਗੂਮੈਂਟਾਂ ਨਾਲ ਜੁੜੇ ਹੁੰਦੇ ਹਨ ਇਹ ਨਿਰਧਾਰਤ ਕਰਨ ਲਈ ਕਿ ਆਰਗੂਮੈਂਟ ਨੂੰ ਕਿਵੇਂ ਪ੍ਰਮਾਣਿਤ ਕੀਤਾ ਜਾਂਦਾ ਹੈ ਅਤੇ ਪਾਈਥਨ ਕਿਸਮ ਵਿੱਚ ਬਦਲਿਆ ਜਾਂਦਾ ਹੈ
|_+_|ਟਾਈਪ ਐਨੋਟੇਸ਼ਨ |
ਨਿਰਦੇਸ਼ ਫੰਕਸ਼ਨ ਜੋ ਤੁਹਾਡੇ api_function ਵਿੱਚ ਇੱਕ ਦਲੀਲ ਵਜੋਂ ਬੇਨਤੀ ਕੀਤੇ ਜਾਣ ਦੇ ਅਧਾਰ ਤੇ ਬੇਨਤੀ / ਜਵਾਬ ਡੇਟਾ ਨਾਲ ਚਲਾਇਆ ਜਾਂਦਾ ਹੈ। ਇਹ ਸਿਰਫ਼ ਇਨਪੁਟ ਪੈਰਾਮੀਟਰਾਂ ਵਜੋਂ ਲਾਗੂ ਹੁੰਦੇ ਹਨ, ਅਤੇ ਵਰਤਮਾਨ ਵਿੱਚ ਆਉਟਪੁੱਟ ਫਾਰਮੈਟਾਂ ਜਾਂ ਪਰਿਵਰਤਨ ਦੇ ਤੌਰ 'ਤੇ ਲਾਗੂ ਨਹੀਂ ਕੀਤੇ ਜਾ ਸਕਦੇ ਹਨ।
|_+_|ਇੱਕ |_+_| ਨਾਲ ਇੱਕ ਦਲੀਲ ਦੁਆਰਾ ਨਿਰਦੇਸ਼ਾਂ ਤੱਕ ਪਹੁੰਚ ਕੀਤੀ ਜਾ ਸਕਦੀ ਹੈ ਪ੍ਰੀਫਿਕਸ, ਜਾਂ ਪਾਈਥਨ 3 ਕਿਸਮ ਦੀਆਂ ਐਨੋਟੇਸ਼ਨਾਂ ਦੀ ਵਰਤੋਂ ਕਰਕੇ। ਬਾਅਦ ਵਾਲਾ ਵਧੇਰੇ ਆਧੁਨਿਕ ਪਹੁੰਚ ਹੈ, ਅਤੇ ਸਿਫਾਰਸ਼ ਕੀਤੀ ਜਾਂਦੀ ਹੈ। ਇੱਕ ਮੋਡੀਊਲ ਵਿੱਚ ਘੋਸ਼ਿਤ ਕੀਤੇ ਨਿਰਦੇਸ਼ਾਂ ਨੂੰ ਉਹਨਾਂ ਦੇ ਪੂਰੀ ਤਰ੍ਹਾਂ ਯੋਗ ਨਾਮ ਦੀ ਕਿਸਮ ਐਨੋਟੇਸ਼ਨ (ਉਦਾਹਰਨ: |_+_|) ਵਜੋਂ ਵਰਤ ਕੇ ਐਕਸੈਸ ਕੀਤਾ ਜਾ ਸਕਦਾ ਹੈ।
priviabillpay.com/quickpay ਕੋਡ
ਸਪੱਸ਼ਟ ਇਨਪੁਟ ਪਰਿਵਰਤਨ ਵਰਤੋਂ ਦੇ ਮਾਮਲੇ ਤੋਂ ਇਲਾਵਾ, ਨਿਰਦੇਸ਼ਾਂ ਦੀ ਵਰਤੋਂ ਤੁਹਾਡੇ API ਫੰਕਸ਼ਨਾਂ ਵਿੱਚ ਡੇਟਾ ਨੂੰ ਪਾਈਪ ਕਰਨ ਲਈ ਕੀਤੀ ਜਾ ਸਕਦੀ ਹੈ, ਭਾਵੇਂ ਉਹ ਬੇਨਤੀ ਪੁੱਛਗਿੱਛ ਸਤਰ, POST ਬਾਡੀ, ਆਦਿ ਵਿੱਚ ਮੌਜੂਦ ਨਹੀਂ ਹਨ। ਇਸ ਤਰੀਕੇ ਨਾਲ ਨਿਰਦੇਸ਼ਾਂ ਦੀ ਵਰਤੋਂ ਕਰਨ ਦੇ ਉਦਾਹਰਨ ਲਈ, ਉਦਾਹਰਣ ਫੋਲਡਰ ਵਿੱਚ ਪ੍ਰਮਾਣਿਕਤਾ ਉਦਾਹਰਨ ਵੇਖੋ।
ਤੁਹਾਡੇ ਆਪਣੇ ਨਿਰਦੇਸ਼ਾਂ ਨੂੰ ਜੋੜਨਾ ਸਿੱਧਾ ਅੱਗੇ ਹੈ:
|_+_|ਸੰਪੂਰਨਤਾ ਲਈ, ਇੱਥੇ ਮੈਜਿਕ ਨਾਮ ਪਹੁੰਚ ਦੁਆਰਾ ਨਿਰਦੇਸ਼ਾਂ ਤੱਕ ਪਹੁੰਚ ਕਰਨ ਦੀ ਇੱਕ ਉਦਾਹਰਨ ਹੈ:
|_+_|ਆਉਟਪੁੱਟ ਫਾਰਮੈਟਰ ਇੱਕ ਫੰਕਸ਼ਨ ਜੋ ਤੁਹਾਡੇ API ਫੰਕਸ਼ਨ ਦਾ ਆਉਟਪੁੱਟ ਲੈਂਦਾ ਹੈ ਅਤੇ API ਦੇ ਉਪਭੋਗਤਾ ਤੱਕ ਟ੍ਰਾਂਸਪੋਰਟ ਲਈ ਇਸਨੂੰ ਫਾਰਮੈਟ ਕਰਦਾ ਹੈ।
|_+_|ਜਿਵੇਂ ਦਿਖਾਇਆ ਗਿਆ ਹੈ, ਤੁਸੀਂ ਇੱਕ ਪੂਰੇ API ਦੇ ਨਾਲ-ਨਾਲ ਇੱਕ ਵਿਅਕਤੀਗਤ API ਕਾਲ ਦੋਵਾਂ ਲਈ ਆਉਟਪੁੱਟ ਫਾਰਮੈਟ ਨੂੰ ਆਸਾਨੀ ਨਾਲ ਬਦਲ ਸਕਦੇ ਹੋ
ਇਨਪੁਟ ਫਾਰਮੈਟਰ ਇੱਕ ਫੰਕਸ਼ਨ ਜੋ ਤੁਹਾਡੇ API ਦੇ ਉਪਭੋਗਤਾ ਤੋਂ ਦਿੱਤੇ ਗਏ ਡੇਟਾ ਦੇ ਮੁੱਖ ਭਾਗ ਨੂੰ ਲੈਂਦਾ ਹੈ ਅਤੇ ਇਸਨੂੰ ਸੰਭਾਲਣ ਲਈ ਫਾਰਮੈਟ ਕਰਦਾ ਹੈ।
|_+_|ਇਨਪੁਟ ਫਾਰਮੈਟਰਾਂ ਨੂੰ |_+_| ਦੇ ਆਧਾਰ 'ਤੇ ਮੈਪ ਕੀਤਾ ਜਾਂਦਾ ਹੈ ਬੇਨਤੀ ਡੇਟਾ ਦਾ, ਅਤੇ ਸਿਰਫ ਬੁਨਿਆਦੀ ਪਾਰਸਿੰਗ ਕਰੋ। ਤੁਹਾਡੇ |_+_| 'ਤੇ ਮੌਜੂਦ ਟਾਈਪ ਐਨੋਟੇਸ਼ਨਾਂ ਦੁਆਰਾ ਵਧੇਰੇ ਵਿਸਤ੍ਰਿਤ ਪਾਰਸਿੰਗ ਕੀਤੀ ਜਾਣੀ ਚਾਹੀਦੀ ਹੈ
ਮਿਡਲਵੇਅਰ ਫੰਕਸ਼ਨ ਜੋ ਹਰ ਬੇਨਤੀ ਲਈ ਇੱਕ ਜੱਫੀ API ਪ੍ਰਕਿਰਿਆਵਾਂ ਲਈ ਬੁਲਾਏ ਜਾਂਦੇ ਹਨ
|_+_|ਤੁਸੀਂ ਆਸਾਨੀ ਨਾਲ ਕਿਸੇ ਵੀ ਫਾਲਕਨ ਸਟਾਈਲ ਮਿਡਲਵੇਅਰ ਨੂੰ ਇਹ ਵਰਤ ਕੇ ਜੋੜ ਸਕਦੇ ਹੋ:
particles.js ਦੀ ਵਰਤੋਂ ਕਿਵੇਂ ਕਰੀਏ|_+_|
ਪੈਰਾਮੀਟਰ ਮੈਪਿੰਗ ਅਨੁਮਾਨਿਤ ਪੈਰਾਮੀਟਰ ਨਾਮਾਂ ਨੂੰ ਓਵਰਰਾਈਡ ਕਰਨ ਲਈ ਵਰਤਿਆ ਜਾ ਸਕਦਾ ਹੈ, ਉਦਾਹਰਨ ਲਈ. ਰਾਖਵੇਂ ਸ਼ਬਦਾਂ ਲਈ:
|_+_|ਇਨਪੁਟ ਫਾਰਮੈਟਰਾਂ ਨੂੰ |_+_| ਦੇ ਆਧਾਰ 'ਤੇ ਮੈਪ ਕੀਤਾ ਜਾਂਦਾ ਹੈ ਬੇਨਤੀ ਡੇਟਾ ਦਾ, ਅਤੇ ਸਿਰਫ ਬੁਨਿਆਦੀ ਪਾਰਸਿੰਗ ਕਰੋ। ਤੁਹਾਡੇ |_+_| 'ਤੇ ਮੌਜੂਦ ਟਾਈਪ ਐਨੋਟੇਸ਼ਨਾਂ ਦੁਆਰਾ ਵਧੇਰੇ ਵਿਸਤ੍ਰਿਤ ਪਾਰਸਿੰਗ ਕੀਤੀ ਜਾਣੀ ਚਾਹੀਦੀ ਹੈ
ਕਈ ਫਾਈਲਾਂ ਉੱਤੇ API ਨੂੰ ਵੰਡਣਾ
ਹੱਗ ਤੁਹਾਨੂੰ ਕਿਸੇ ਵੀ ਤਰੀਕੇ ਨਾਲ ਵੱਡੇ ਪ੍ਰੋਜੈਕਟਾਂ ਨੂੰ ਸੰਗਠਿਤ ਕਰਨ ਦੇ ਯੋਗ ਬਣਾਉਂਦਾ ਹੈ ਜੋ ਤੁਸੀਂ ਠੀਕ ਦੇਖਦੇ ਹੋ। ਤੁਸੀਂ ਕਿਸੇ ਵੀ ਮੌਡਿਊਲ ਨੂੰ ਆਯਾਤ ਕਰ ਸਕਦੇ ਹੋ ਜਿਸ ਵਿੱਚ ਹੱਗ ਸਜਾਏ ਗਏ ਫੰਕਸ਼ਨ ਸ਼ਾਮਲ ਹਨ (ਬੇਨਤੀ ਹੈਂਡਲਿੰਗ, ਨਿਰਦੇਸ਼, ਟਾਈਪ ਹੈਂਡਲਰ, ਆਦਿ) ਅਤੇ ਉਸ ਮੋਡੀਊਲ ਨਾਲ ਆਪਣੇ ਅਧਾਰ API ਨੂੰ ਵਧਾ ਸਕਦੇ ਹੋ।
ਉਦਾਹਰਣ ਲਈ:
|_+_|
|_+_|ਮੁੱਖ API ਫਾਈਲ ਵਿੱਚ ਆਯਾਤ ਕੀਤਾ ਜਾ ਸਕਦਾ ਹੈ:
|_+_|
|_+_|ਜਾਂ ਵਿਕਲਪਿਕ ਤੌਰ 'ਤੇ - ਇਸ ਤਰ੍ਹਾਂ ਦੇ ਮਾਮਲਿਆਂ ਲਈ - ਜਿੱਥੇ URL ਰੂਟ ਪ੍ਰਤੀ ਸਿਰਫ ਇੱਕ ਮੋਡੀਊਲ ਸ਼ਾਮਲ ਕੀਤਾ ਜਾ ਰਿਹਾ ਹੈ:
|_+_|ਹੱਗ 404 ਦੀ ਸੰਰਚਨਾ ਕੀਤੀ ਜਾ ਰਹੀ ਹੈ
ਪੂਰਵ-ਨਿਰਧਾਰਤ ਤੌਰ 'ਤੇ, ਜਦੋਂ ਕੋਈ ਉਪਭੋਗਤਾ ਕਿਸੇ ਅਜਿਹੇ ਅੰਤਮ ਬਿੰਦੂ ਨੂੰ ਐਕਸੈਸ ਕਰਨ ਦੀ ਕੋਸ਼ਿਸ਼ ਕਰਦਾ ਹੈ ਜੋ ਪਰਿਭਾਸ਼ਿਤ ਨਹੀਂ ਹੈ, ਤਾਂ ਹੱਗ ਇੱਕ ਸਵੈ-ਤਿਆਰ API ਸਪੀਕ ਵਾਪਸ ਕਰਦਾ ਹੈ। ਜੇ ਤੁਸੀਂ ਇਸ ਵਿਸ਼ੇਸ਼ਤਾ ਨੂੰ ਵਾਪਸ ਨਹੀਂ ਕਰਨਾ ਚਾਹੁੰਦੇ ਹੋ ਤਾਂ ਤੁਸੀਂ 404 ਦਸਤਾਵੇਜ਼ਾਂ ਨੂੰ ਬੰਦ ਕਰ ਸਕਦੇ ਹੋ:
ਕਮਾਂਡ ਲਾਈਨ ਐਪਲੀਕੇਸ਼ਨ ਤੋਂ:
|_+_|ਇਸ ਤੋਂ ਇਲਾਵਾ, ਤੁਸੀਂ |_+_| ਦੀ ਵਰਤੋਂ ਕਰਕੇ ਆਸਾਨੀ ਨਾਲ ਇੱਕ ਕਸਟਮ 404 ਹੈਂਡਲਰ ਬਣਾ ਸਕਦੇ ਹੋ ਸਜਾਵਟ ਕਰਨ ਵਾਲਾ:
|_+_|ਇਹ ਸਜਾਵਟ ਉਸੇ ਤਰੀਕੇ ਨਾਲ ਕੰਮ ਕਰਦਾ ਹੈ ਜਿਵੇਂ ਕਿ ਹੱਗ HTTP ਵਿਧੀ ਸਜਾਵਟ ਕਰਨ ਵਾਲੇ, ਅਤੇ ਸੰਸਕਰਣ ਜਾਣੂ ਵੀ ਹੈ:
|_+_|Asyncio ਸਹਿਯੋਗ
|_+_| ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਸਮੇਂ ਅਤੇ |_+_| coroutines 'ਤੇ ਢੰਗ ਸਜਾਵਟ, ਜੱਫੀ coroutine ਦੇ ਐਗਜ਼ੀਕਿਊਸ਼ਨ ਨੂੰ ਤਹਿ ਕਰੇਗਾ.
ਅਸਿੰਸੀਓ ਕੋਰੋਟੀਨ ਡੈਕੋਰੇਟਰ ਦੀ ਵਰਤੋਂ ਕਰਨਾ
|_+_|ਪਾਈਥਨ 3.5 ਅਸਿੰਕ ਕੀਵਰਡ ਦੀ ਵਰਤੋਂ ਕਰਨਾ।
|_+_|ਨੋਟ: ਹੱਗ ਟਾਪ ਫਾਲਕਨ 'ਤੇ ਚੱਲ ਰਿਹਾ ਹੈ ਜੋ ਕਿ ਅਸਿੰਕ੍ਰੋਨਸ ਸਰਵਰ ਨਹੀਂ ਹੈ। ਭਾਵੇਂ ਅਸਿੰਸੀਓ ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਹੋਏ, ਬੇਨਤੀਆਂ ਨੂੰ ਸਮਕਾਲੀ ਰੂਪ ਵਿੱਚ ਪ੍ਰਕਿਰਿਆ ਕੀਤਾ ਜਾਵੇਗਾ।
ਡੌਕਰ ਦੀ ਵਰਤੋਂ ਕਰਨਾ
ਜੇਕਰ ਤੁਸੀਂ ਡੌਕਰ ਵਿੱਚ ਵਿਕਸਤ ਕਰਨਾ ਅਤੇ ਆਪਣੇ ਸਿਸਟਮ ਨੂੰ ਸਾਫ਼ ਰੱਖਣਾ ਚਾਹੁੰਦੇ ਹੋ, ਤਾਂ ਤੁਸੀਂ ਅਜਿਹਾ ਕਰ ਸਕਦੇ ਹੋ ਪਰ ਤੁਹਾਨੂੰ ਪਹਿਲਾਂ ਡੌਕਰ ਕੰਪੋਜ਼ ਨੂੰ ਸਥਾਪਤ ਕਰਨ ਦੀ ਲੋੜ ਹੋਵੇਗੀ।
ਇੱਕ ਵਾਰ ਜਦੋਂ ਤੁਸੀਂ ਇਹ ਕਰ ਲੈਂਦੇ ਹੋ, ਤਾਂ ਤੁਹਾਨੂੰ |_+_| ਦੀ ਲੋੜ ਪਵੇਗੀ |_+_| ਵਿੱਚ ਡਾਇਰੈਕਟਰੀ ਅਤੇ |_+_| ਵਿੱਚ ਦਰਸਾਏ ਗਏ ਵੈੱਬ ਸਰਵਰ (ਗੁਨੀਕੋਰਨ) ਨੂੰ ਚਲਾਓ, ਜਿਸ ਤੋਂ ਬਾਅਦ ਤੁਸੀਂ ਆਪਣੀ ਹੋਸਟ ਮਸ਼ੀਨ 'ਤੇ ਬ੍ਰਾਊਜ਼ਰ ਵਿੱਚ ਆਪਣੇ API ਦੇ ਆਉਟਪੁੱਟ ਦੀ ਝਲਕ ਦੇਖ ਸਕਦੇ ਹੋ।
|_+_|ਮੂਲ ਰੂਪ ਵਿੱਚ, IP 172.17.0.1 ਹੈ। ਇਹ ਮੰਨ ਕੇ ਕਿ ਇਹ ਉਹ IP ਹੈ ਜੋ ਤੁਸੀਂ ਦੇਖਦੇ ਹੋ, ਨਾਲ ਹੀ, ਤੁਸੀਂ ਫਿਰ |_+_| 'ਤੇ ਜਾਓਗੇ ਤੁਹਾਡੇ API ਨੂੰ ਦੇਖਣ ਲਈ ਤੁਹਾਡੇ ਬ੍ਰਾਊਜ਼ਰ ਵਿੱਚ।
ਤੁਸੀਂ ਇੱਕ ਡੌਕਰ ਕੰਟੇਨਰ ਵਿੱਚ ਵੀ ਲੌਗਇਨ ਕਰ ਸਕਦੇ ਹੋ ਜਿਸ ਨੂੰ ਤੁਸੀਂ ਆਪਣੇ ਕੰਮ ਦੀ ਥਾਂ 'ਤੇ ਵਿਚਾਰ ਕਰ ਸਕਦੇ ਹੋ। ਇਸ ਵਰਕਸਪੇਸ ਵਿੱਚ ਪਾਈਥਨ ਅਤੇ ਪਾਈਪ ਸਥਾਪਤ ਹੈ ਤਾਂ ਜੋ ਤੁਸੀਂ ਡੌਕਰ ਦੇ ਅੰਦਰ ਉਹਨਾਂ ਟੂਲਸ ਦੀ ਵਰਤੋਂ ਕਰ ਸਕੋ। ਜੇ ਤੁਹਾਨੂੰ CLI ਇੰਟਰਫੇਸ ਦੀ ਜਾਂਚ ਕਰਨ ਦੀ ਲੋੜ ਹੈ, ਉਦਾਹਰਨ ਲਈ, ਤੁਸੀਂ ਇਸਦੀ ਵਰਤੋਂ ਕਰੋਗੇ।
|_+_|ਤੁਹਾਡੇ ਡੌਕਰ 'ਤੇ |_+_| ਕੰਟੇਨਰ, |_+_| ਤੁਹਾਡੇ ਹੋਸਟ ਕੰਪਿਊਟਰ 'ਤੇ ਡਾਇਰੈਕਟਰੀ ਨੂੰ |_+_| 'ਤੇ ਮਾਊਂਟ ਕੀਤਾ ਗਿਆ ਹੈ ਡੌਕਰ ਕੰਟੇਨਰ ਵਿੱਚ. ਇਹ |_+_| ਦੇ ਅਧੀਨ ਦਰਸਾਈ ਗਈ ਹੈ > |_+_| ਦਾ |_+_|।
|_+_|ਸੁਰੱਖਿਆ ਸੰਪਰਕ ਜਾਣਕਾਰੀ
ਜੱਫੀ ਸੁਰੱਖਿਆ ਅਤੇ ਗੁਣਵੱਤਾ ਨੂੰ ਗੰਭੀਰਤਾ ਨਾਲ ਲੈਂਦਾ ਹੈ। ਇਹ ਫੋਕਸ ਇਸ ਲਈ ਹੈ ਕਿ ਅਸੀਂ ਆਪਣੇ ਕੋਡ ਬੇਸ ਦੀ ਸੁਰੱਖਿਆ ਦੀ ਪੁਸ਼ਟੀ ਕਰਨ ਲਈ ਸਿਰਫ਼ ਚੰਗੀ ਤਰ੍ਹਾਂ ਜਾਂਚੇ ਗਏ ਹਿੱਸਿਆਂ 'ਤੇ ਨਿਰਭਰ ਕਰਦੇ ਹਾਂ ਅਤੇ ਸਥਿਰ ਵਿਸ਼ਲੇਸ਼ਣ ਟੂਲ (ਜਿਵੇਂ ਕਿ ਡਾਕੂ ਅਤੇ ਸੁਰੱਖਿਆ) ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਹਾਂ। ਜੇਕਰ ਤੁਹਾਨੂੰ ਕੋਈ ਸੰਭਾਵੀ ਸੁਰੱਖਿਆ ਸਮੱਸਿਆਵਾਂ ਮਿਲਦੀਆਂ ਜਾਂ ਆਉਂਦੀਆਂ ਹਨ, ਤਾਂ ਕਿਰਪਾ ਕਰਕੇ ਸਾਨੂੰ ਤੁਰੰਤ ਦੱਸੋ ਤਾਂ ਜੋ ਅਸੀਂ ਉਹਨਾਂ ਨੂੰ ਹੱਲ ਕਰ ਸਕੀਏ।
ਸੁਰੱਖਿਆ ਕਮਜ਼ੋਰੀ ਦੀ ਰਿਪੋਰਟ ਕਰਨ ਲਈ, ਕਿਰਪਾ ਕਰਕੇ ਟਿਡਲਿਫਟ ਸੁਰੱਖਿਆ ਸੰਪਰਕ ਦੀ ਵਰਤੋਂ ਕਰੋ। ਟਾਈਡਲਿਫਟ ਫਿਕਸ ਅਤੇ ਖੁਲਾਸੇ ਦਾ ਤਾਲਮੇਲ ਕਰੇਗਾ।
ਗਲੇ ਕਿਉਂ?
HUG ਦਾ ਅਰਥ ਹੈ ਆਸਪਾਸ ਉਪਯੋਗੀ ਗਾਈਡ। ਇਹ ਚੰਗੀ ਤਰ੍ਹਾਂ ਲਿਖਤੀ ਅਤੇ ਅਨੁਭਵੀ API ਬਣਾਉਣ ਵਿੱਚ ਡਿਵੈਲਪਰਾਂ ਦੀ ਅਗਵਾਈ ਕਰਨ ਵਿੱਚ ਮਦਦ ਕਰਨ ਲਈ ਪ੍ਰੋਜੈਕਟ ਦੇ ਟੀਚੇ ਨੂੰ ਦਰਸਾਉਂਦਾ ਹੈ।
ਧੰਨਵਾਦ ਅਤੇ ਮੈਨੂੰ ਉਮੀਦ ਹੈ ਕਿ ਤੁਸੀਂ ਲੱਭੋਗੇ ਇਹ ਜਦੋਂ ਤੁਸੀਂ ਆਪਣਾ ਅਗਲਾ Python API ਵਿਕਸਿਤ ਕਰਦੇ ਹੋ ਤਾਂ ਮਦਦਗਾਰ ਹੱਗ ਕਰੋ!
~ ਟਿਮੋਥੀ ਕਰਾਸਲੇ
ਡਾਊਨਲੋਡ ਵੇਰਵੇ:
ਲੇਖਕ: hugapi
ਡਾਊਨਲੋਡ ਲਿੰਕ: ਸਰੋਤ ਕੋਡ ਡਾਊਨਲੋਡ ਕਰੋ
ਅਧਿਕਾਰਤ ਵੈੱਬਸਾਈਟ: https://github.com/hugapi/hug
ਲਾਇਸੰਸ: MIT ਲਾਇਸੰਸ
#python